nominal_catalog

Documentation

Overview

Code generated by https://github.com/GoComply/metaschema; DO NOT EDIT.

Index

• type Choice
• type Constraint
• type Guideline
• type Label
• type Link
• type Markup
• type NominalCatalog
• type Param
  • func (param *Param) TextRepresentation() string
• type ParamResolver
• type Part
  • func (part *Part) ModifyProse(parameterID, parameterVal string)
  • func (p *Part) ResolveInserts(resolver ParamResolver) string
• type Prop
• type Prose
• type Select
• type Title
• type Usage
• type Value

Types

type Choice

type Choice = Markup

A value selection among several such options

type Constraint

type Constraint struct {
	// A formal (executable) expression of a constraint
	Test   string `xml:"test,attr,omitempty" json:"test,omitempty"`
	Detail string `xml:",chardata" json:"detail"`
}

A formal or informal expression of a constraint or test

type Guideline

type Guideline struct {

	// Prose permits multiple paragraphs, lists, tables etc.
	Prose *Prose `xml:",any" json:"prose,omitempty"`
}

A prose statement that provides a recommendation for the use of a parameter.

type Label

type Label = Markup

A placeholder for a missing value, in display.

type Link

type Link = validation_root.Link

type Markup

type Markup = validation_root.Markup

type NominalCatalog

type NominalCatalog struct {

	// Parameters provide a mechanism for the dynamic assignment of value(s) in a control.
	Param *Param `xml:"param,omitempty" json:"param,omitempty"`
	// A partition or component of a control or part
	Part *Part `xml:"part,omitempty" json:"part,omitempty"`
}

NOT TO BE USED FOR A BASE METASCHEMA ONLY FOR A MODULE

type Param

type Param struct {

	// Unique identifier of the containing object
	Id string `xml:"id,attr,omitempty" json:"id,omitempty"`
	// Indicating the type or classification of the containing object
	Class string `xml:"class,attr,omitempty" json:"class,omitempty"`
	// Another parameter invoking this one
	DependsOn string `xml:"depends-on,attr,omitempty" json:"depends-on,omitempty"`

	// A short name for the parameter.
	Label *Label `xml:"label,omitempty" json:"label,omitempty"`
	// Indicates and explains the purpose and use of a parameter
	Descriptions []Usage `xml:"usage,omitempty" json:"descriptions,omitempty"`
	// A formal or informal expression of a constraint or test
	Constraints []Constraint `xml:"constraint,omitempty" json:"constraints,omitempty"`
	// A prose statement that provides a recommendation for the use of a parameter.
	Guidance []Guideline `xml:"guideline,omitempty" json:"guidance,omitempty"`
	// A recommended parameter value or set of values.
	Value *Value `xml:"value,omitempty" json:"value,omitempty"`
	// A set of parameter value choices, that may be picked from to set the parameter value.
	Select *Select `xml:"select,omitempty" json:"select,omitempty"`
	// A reference to a local or remote resource
	Links []Link `xml:"link,omitempty" json:"links,omitempty"`
}

Parameters provide a mechanism for the dynamic assignment of value(s) in a control.

func (*Param) TextRepresentation

func (param *Param) TextRepresentation() string

type ParamResolver

type ParamResolver interface {
	FindParam(id string) *Param
}

type Part

type Part struct {

	// Unique identifier of the containing object
	Id string `xml:"id,attr,omitempty" json:"id,omitempty"`
	// Identifying the purpose and intended use of the property, part or other object.
	Name string `xml:"name,attr,omitempty" json:"name,omitempty"`
	// A namespace qualifying the name.
	Ns string `xml:"ns,attr,omitempty" json:"ns,omitempty"`
	// Indicating the type or classification of the containing object
	Class string `xml:"class,attr,omitempty" json:"class,omitempty"`

	// A title for display and navigation
	Title *Title `xml:"title,omitempty" json:"title,omitempty"`
	// A value with a name, attributed to the containing control, part, or group.
	Properties []Prop `xml:"prop,omitempty" json:"properties,omitempty"`
	// Prose permits multiple paragraphs, lists, tables etc.
	Prose *Prose `xml:",any" json:"prose,omitempty"`
	// A partition or component of a control or part
	Parts []Part `xml:"part,omitempty" json:"parts,omitempty"`
	// A reference to a local or remote resource
	Links []Link `xml:"link,omitempty" json:"links,omitempty"`
}

A partition or component of a control or part

func (*Part) ModifyProse

func (part *Part) ModifyProse(parameterID, parameterVal string)

ModifyProse modifies prose insert parameter template

func (*Part) ResolveInserts

func (p *Part) ResolveInserts(resolver ParamResolver) string

type Prop

type Prop = validation_root.Prop

type Prose

type Prose = Markup

Prose permits multiple paragraphs, lists, tables etc.

type Select

type Select struct {

	// When selecting, a requirement such as one or more
	HowMany string `xml:"how-many,attr,omitempty" json:"how-many,omitempty"`

	// A value selection among several such options
	Alternatives []Choice `xml:"choice,omitempty" json:"alternatives,omitempty"`
}

Presenting a choice among alternatives

type Title

type Title = validation_root.Title

type Usage

type Usage struct {
	// Unique identifier of the containing object
	Id      string `xml:"id,attr,omitempty" json:"id,omitempty"`
	Summary string `xml:",chardata" json:"summary"`
}

Indicates and explains the purpose and use of a parameter

type Value

type Value = Markup

Indicates a permissible value for a parameter or property