GDMO Templates

Solstice Enterprise Manager 4.1 Developing C++ Applications

Appendix C

GDMO Templates

This appendix describes the templates defined by ITU-T X.722/ISO-10165-4 Guidelines for the Definition of Managed Objects (GDMO).

Section C.1 Conventions Used in the Definitions
Section C.2 Managed Object Class Template
Section C.3 Name Binding Template
Section C.4 Package Template
Section C.5 Attribute Template
Section C.6 Action Template
Section C.7 Notification Template
Section C.8 Parameter Template
Section C.9 Attribute Group Template
Section C.10 Behaviour Template

C.1 Conventions Used in the Definitions

In the template definitions:

Capitalized words are GDMO keywords.
Words in angle brackets represent information that is filled in when a template is instantiated.
An item in square brackets represents an optional value.
A closing square bracket followed by an asterisk indicates that the item enclosed in brackets may be repeated zero or more times.
Note – Some items are references to an instance of use of another GDMO template. If an item is defined in a different GDMO document, the item must be specified as a fully-qualified name, that is: <GDMO-Document-Name> : <label>.

C.2 Managed Object Class Template

The Managed Object Class template references all other templates to make up the managed object class definition.

The Managed Object Class template references the following other templates either directly or indirectly:

Package
Parameter
Attribute
Attribute Group
Behaviour
Action
Notification

C.2.1 Managed Object Class Template Format

The format of the Managed Object Class template is as follows:
<class-label> MANAGED OBJECT CLASS

    [DERIVED FROM          <class-label>    [,<class-label>]*;

    ]

    [CHARACTERIZED BY      <package-label>  [,<package-label>]*;

    ]

    [CONDITIONAL PACKAGES  <package-label> PRESENT IF condition-definition

                           [,<package-label> PRESENT IF condition-definition]*;

    ]

REGISTERED AS object-identifier;
C.2.2 Managed Object Class Template Constructs

The meaning of each construct in the Managed Object Class template is defined in TABLE C-1.

TABLE C-1 Managed Object Class Template Constructs
Construct Description

<class-label> MANAGED OBJECT CLASS
The MANAGED OBJECT CLASS construct identifies the template as a definition for a managed object class.
<class-label> specifies the name of the managed object class. The REGISTERED AS construct in the template associates a unique object identifier with this label.

DERIVED FROM <class-label> [,<class-label>]*
The DERIVED FROM construct identifies other managed object classes that are base classes of the managed object class that is being defined.
Each <class-label> specifies a base class of the managed object class that is being defined.

CHARACTERIZED BY <package-label> [,<package-label>]*
The CHARACTERIZED BY construct identifies the packages that the managed object class supports. A package defines a set of behaviors, attributes, operations, and notifications. For detailed information on the contents of a package, see Section C.4 Package Template.
Each <package-label> is the name of a package that the managed object class supports.

CONDITIONAL PACKAGES <package-label> PRESENT IF condition-definition [,<package-label>
PRESENT IF condition-definition]
The CONDITIONAL PACKAGES construct identifies any packages that are conditionally supported by the managed object class. Each conditional package will be included in a managed object instance if the condition specified by the PRESENT IF clause for the package is true.
Each <package-label> is the name of a conditional package.
Each condition-definition specifies a condition that must be true for the package to be included in a managed object instance when the instance is created.

REGISTERED AS object-identifier
The REGISTERED AS construct identifies the globally unique identifier assigned to the managed object class.
object-identifier is replaced with the object identifier (OID) that globally and uniquely identifies the managed object class.

C.3 Name Binding Template

The Name Binding template specifies instantiation and legal parameters for managed objects. Containment, creation, and deletion constraints are initiated from this template.

C.3.1 Name Binding Template Format

The format of the Name Binding template is as follows:
<name-binding-label> NAME BINDING

    SUBORDINATE OBJECT CLASS          <class-label> [AND SUBCLASSES];

    NAMED BY SUPERIOR OBJECT CLASS    <class-label> [AND SUBCLASSES];

    WITH ATTRIBUTE                    <attribute-label>;

    [BEHAVIOUR                       <behaviour-definition-label>

                                     [,<behaviour-definition-label>]*;

    ]

    [CREATE                          [create-modifier [,create-modifier]]

                                     [<parameter-label>]*;

    ]

    [DELETE                          [delete-modifier] [<parameter-label>]*;

    ]

REGISTERED AS     object-identifier;
C.3.2 Name Binding Template Constructs

The meaning of each construct in the Name Binding template is explained in TABLE C-2.

TABLE C-2 Name Binding Template Constructs
Construct Description

<name-binding-label> NAME BINDING
The NAME BINDING construct identifies the template as a definition for a name binding.
<name-binding-label> specifies the name of the name binding. The REGISTERED AS construct in the template associates a unique OID with this label.

SUBORDINATE OBJECT CLASS <class-label> [AND SUBCLASSES]
The SUBORDINATE OBJECT CLASS construct identifies a managed object class whose instances can be named by using an instance of the managed object class specified in the NAMED BY SUPERIOR OBJECT CLASS construct.
<class-label> identifies the subordinate managed object class.
AND SUBCLASSES, if included, specifies that instances of a derived class of the subordinate class can also be named by using an instance of the class specified in the NAMED BY SUPERIOR OBJECT CLASS construct.

NAMED BY SUPERIOR OBJECT CLASS <class-label> [AND SUBCLASSES]
The NAMED BY SUPERIOR OBJECT CLASS construct identifies a managed object class whose instances can be used to name an instance of the managed object class specified in the SUBORDINATE OBJECT CLASS construct.
<class-label> identifies the superior managed object class.
AND SUBCLASSES, if included, specifies that instances of a derived class of the superior class can also be used to name an instance of the class specified in the SUBORDINATE OBJECT CLASS construct.

WITH ATTRIBUTE <attribute-label>
The WITH ATTRIBUTE construct identifies the attribute that will be used to form the relative distinguished name (RDN) of an instance of the managed object class specified in the SUBORDINATE OBJECT CLASS construct.
<attribute-label> identifies the attribute used to form the RDN for an instance of the object class specified by the SUBORDINATE OBJECT CLASS construct.
For more information on RDNs, refer to Section 2.2.6.2 Names of Managed Object Instances.

BEHAVIOUR <behaviour-definition-label> [,<behaviour-definition-label>]*
The BEHAVIOUR construct specifies any behavior impact that results specifically due to the use of the name binding.
Each <behaviour-definition-label> identifies a behavior as defined in an instance of use of the Behaviour template.

CREATE [create-modifier [,create-modifier]] [<parameter-label>]*
The CREATE construct specifies that an instance of managed object class specified by the SUBORDINATE OBJECT CLASS construct can be created by a management operation (normally a CMIS M-CREATE operation).
create-modifier specifies permitted options for an M-CREATE operation. The options are as follows:
WITH-REFERENCE-OBJECT - Specifies that a reference object may be specified in an M-CREATE operation
WITH-AUTOMATIC-INSTANCE-NAMING - Specifies that the object instance name can be omitted from the M-CREATE operation
<parameter-label> identifies name binding error parameters associated with create operations.

DELETE [delete-modifier] [<parameter-label>]*
The DELETE construct specifies that an instance of managed object class specified by the SUBORDINATE OBJECT CLASS construct can be deleted by a management operation (normally a CMIS M-DELETE operation).
delete-modifier specifies behavior for a managed object instance when the instance is deleted. The options are as follows:
ONLY-IF-NO-CONTAINED-OBJECTS - Specifies that a delete operation will fail and return an error if there are any contained managed object instances under the instance being deleted
DELETES-CONTAINED-OBJECTS - Specifies that a delete operation will fail and return an error if any of the managed object instances directly or indirectly under the instance being deleted are subject to the ONLY-IF-NO-CONTAINED-OBJECTS delete modifier
<parameter-label> identifies name binding error parameters associated with delete operations.

REGISTERED AS object-identifier
The REGISTERED AS construct identifies the globally unique identifier assigned to the name binding.
object-identifier is replaced with the OID that globally and uniquely identifies the name binding.

C.4 Package Template

The Package template is defines a combination of behavior definitions, attributes, attribute groups, operations, actions, notifications, and parameters for later inclusion in a managed object class template. A package can be referenced by more than one managed object class definition.

C.4.1 Package Template Format

The format of the Package template is as follows:
<package-label> PACKAGE

    [BEHAVIOUR         <behaviour-definition-label>

                       [,<behaviour-definition-label>]*;

   ]

    [ATTRIBUTES       <attribute-label> propertyList [<parameter-label>] *

                      [,<attribute-label> propertyList [<parameter-label>]*]*;

    ]

    [ATTRIBUTE GROUPS <group-label> [<attribute-label>]*

                      [,<group-label> [<attribute-label>]*]*;

    ]

    [ACTIONS          <action-label> [<parameter-label>] *

                      [,<action-label> [<parameter-label>]*]*;

    ]

    [NOTIFICATIONS   <notification-label> [<parameter-label>]*

                     [,<notification-label> [<parameter-label>]*]*;

    ]

[REGISTERED AS object-identifier];
C.4.2 Package Template Constructs

The meaning of each construct in the Package template is explained in TABLE C-3.

TABLE C-3 Package Template Constructs
Construct Description

<package-label> PACKAGE
The PACKAGE construct identifies the template as a definition for a package.
<package-label> specifies the name of the package. The REGISTERED AS construct in the template associates a unique OID with this label.

BEHAVIOUR <behaviour-definition-label> [,<behaviour-definition-label>]*
The BEHAVIOUR construct enables the semantics of the package to be completely described. This construct relates the external view of aspects of a managed object, such as its operations and notifications, to its internal operation.
Each <behaviour-definition-label> identifies a behavior as defined in an instance of use of the Behaviour template.

ATTRIBUTES <attribute-label> propertyList [<parameter-label>] *[,<attribute-label> propertyList [<parameter-label>]*]*
The ATTRIBUTES construct defines operations permitted on a managed object with respect to its attributes.
Each <attribute-label> specifies the name of an attribute.
Each propertyList specifies the operations permitted on a managed object with respect to the attribute associated with the propertyList. The format of a propertyList is defined in Section C.4.3 PropertyList Supporting Production.
Each <parameter-label> specifies an error parameter specific to the managed object class. This parameter is associated with management operations on the attribute.

ATTRIBUTE GROUPS <group-label> [<attribute-label>]* [,<group-label> [<attribute-label>]*]*
The ATTRIBUTE GROUPS construct enables a set of attribute groups to be identified as part of the package.
Each <group-label> specifies the name of an attribute group.
Each <attribute-label> specifies the name of an attribute in an attribute group.

ACTIONS <action-label> [<parameter-label>] * [,<action-label> [<parameter-label>]*]*
The ACTIONS construct specifies a set of action definitions that are included in the package.
Each <action-label> specifies the name of an action.
Each <parameter-label> specifies the name of an action information, action reply or error parameter.

NOTIFICATIONS <notification-label> [<parameter-label>]* [,<notification-label [<parameter-label>]*]*
The NOTIFICATIONS construct specifies the notifications that are included in the package.
Each <notification-label> specifies the name of a notification.
Each <parameter-label> specifies the name of a parameter.

REGISTERED AS object-identifier
The REGISTERED AS construct identifies the globally unique identifier assigned to the package.
object-identifier is replaced with the OID that globally and uniquely identifies the package.

C.4.3 PropertyList Supporting Production

The format of the propertyList supporting production is as follows:
[REPLACE-WITH-DEFAULT]

[DEFAULT VALUE      value-specifier]

[INITIAL VALUE      value-specifier]

[PERMITTED VALUES   type-reference]

[REQUIRED VALUES    type-reference]

[get-replace]

[add-remove]

[SET-BY-CREATE]

[NO-MODIFY]
The items in the propertyList supporting production are defined in TABLE C-4.

TABLE C-4 propertyList Supporting Production Definitions
Item Description

REPLACE-WITH-DEFAULT
Specifies that a management operation can set the attribute to a default value. If this property is specified but the DEFAULT VALUE property is not specified, the default value is determined by other means local to the management system.

DEFAULT VALUE value-specifier
Specifies that the attribute has a default value given by value-specifier.

INITIAL VALUE value-specifier
Specifies that the attribute must be set at creation time to the value given by value-specifier.

PERMITTED VALUES type-reference
Specifies that permitted values of the attribute are restricted to those given by type-reference.

REQUIRED VALUES type-reference
Specifies that the attribute shall be able to take any values given by type-reference. This property defines the value set required for conformance.

value-specifier
Specifies the value in a DEFAULT VALUE or INITIAL VALUE property.
value-specifier is one of the following:
value-reference - The value is a fully qualified reference to a data value defined in an ASN.1 module, that is: ASN.1-Module-Name.data-value-label.
DERIVATION RULE <behaviour-definition-label> - The value is determined by the derivation rule specified in <behaviour-definition-label>. <behaviour-definition-label> identifies a behavior as defined in an instance of use of the Behaviour template.

type-reference
Specifies the values in a PERMITTED VALUES or a REQUIRED VALUES property.
type-reference is a fully qualified reference to a data type defined in an ASN.1 module, that is: ASN.1-Module-Name.data-type-label.

get-replace
Specifies the management operations allowed on the attribute. get-replace is one of the following:
GET - A management operation can read the attribute.
REPLACE - A management operation can set the attribute.
GET-REPLACE - A management operation can read or set the attribute.

add-remove
Specifies, for a multi-valued attribute only, how a management operation is allowed to add or remove values in the attribute. add-remove is one of the following:
ADD - A management operation can add a value to the attribute.
REMOVE - A management operation can remove a value from the attribute.
ADD-REMOVE - A management operation can add a value to or remove a value from the attribute.

SET-BY-CREATE
Specifies that the attribute may be set by a creation operation (normally a CMIS M-CREATE operation). The SET-BY-CREATE property is meaningful only if the name binding of the managed object instances supports the creation operation.

NO-MODIFY
Specifies that the attribute cannot be modified in the class that has this property and in all subclasses and compatible managed objects. This property is not allowed in a managed object class definition that has the REPLACE, GET-REPLACE, ADD, REMOVE, or ADD-REMOVE properties on the same attribute.

C.5 Attribute Template

The Attribute template defines attributes used by GDMO classes. A single attribute can be referenced by more than one managed object class definition.

The Attribute template defines individual attribute types. If desired these attribute types can be combined in a group by using the Attribute Group template.

C.5.1 Attribute Template Format

The format of the Attribute template is as follows:
<attribute-label> ATTRIBUTE

    derived-or-with-syntax-choice;

    [MATCHES FOR qualifier [,qualifier]*;]

    [BEHAVIOUR   <behaviour-definition-label> [,<behaviour-definition-label>]*;

    ]

    [PARAMETER  <parame ter-label> [<parameter-label>]*;

    ]

[REGISTERED AS object-identifier];
C.5.2 Attribute Template Constructs

The meaning of each construct in the Attribute template is explained in TABLE C-5.

TABLE C-5 Attribute Template Constructs
Construct Description

<attribute-label> ATTRIBUTE
The ATTRIBUTE construct identifies the template as a definition for an attribute.
<attribute-label> specifies the name of the attribute. The REGISTERED AS construct in the template associates a unique object identifier with this label.

derived-or-with-syntax-choice
This construct specifies how the attribute is defined. derived-or-with-syntax-choice is one of the following mutually exclusive options:
DERIVED FROM <attribute-label> - The attribute is based on the definition referenced by <attribute-label>.
WITH ATTRIBUTE SYNTAX <type-reference> - The data type of the attribute is the ASN.1 type specified by <type-reference>.

MATCHES FOR qualifier [,qualifier]*
The MATCHES FOR construct defines the types of tests that may be applied to the value of the attribute by using a filter operation. Each qualifier is one of the following:
EQUALITY - The attribute value can be tested for equality against a given value.
ORDERING - The attribute value can be tested against a given value to determine which value is greater.
SUBSTRINGS - The attribute value can be tested against a given substring to determine if the attribute value is present in the substring.
SET-COMPARISON - The attribute value can be tested against a given value to determine if the attribute value is a subset or superset of the given value.
SET-INTERSECTION - The attribute value can be tested against a given value to determine if there is a nonnull set intersection between the two values.

BEHAVIOUR <behaviour-definition-label> [,<behaviour-definition-label>]*
The BEHAVIOUR construct specifies behavior that is generic to this attribute.
Each <behaviour-definition-label> specifies an instance of use of the Behaviour template.

PARAMETER <parameter-label> [<parameter-label>]*
The PARAMETER construct associates parameters with the behavior of the attribute for the definition of processing failures.
Each <parameter-label> specifies a processing failure parameter for the attribute.

REGISTERED AS object-identifier
The REGISTERED AS construct identifies the globally unique identifier assigned to the attribute.
object-identifier is replaced with the OID that globally and uniquely identifies the attribute.

C.6 Action Template

The Action template defines actions that can be performed by a managed object class. The Action template defines actions that are performed by using the CMIS M-ACTION service. The template does not include actions or behavior defined for other CMIS services, such as M-GET, or M-SET, for example. An action can be referenced by more than one managed object class.

The Action template defines the behavior and syntax of an action. The syntax definitions specify the contents of the action information and action reply fields in CMIS action requests and responses.

C.6.1 Action Template Format

The format of the Action template is as follows:
<action-label> ACTION

    [BEHAVIOUR                      <behaviour-definition-label>

                                    [,<behaviour-definition-label>]*;

    ]

    [MODE CONFIRMED;

    ]

    [PARAMETERS                     <parameter-label> [<parameter-label>]*;

    ]

    [WITH INFORMATION SYNTAX        type-reference;

    ]

    [WITH REPLY SYNTAX              type-reference;]

REGISTERED AS object-identifier;
C.6.2 Action Template Constructs

The meaning of each construct the Action template is explained in TABLE C-6.

TABLE C-6 Action Template Constructs
Construct Description

<action-label> ACTION
The ACTION construct identifies the template as a definition for an attribute.
<action-label> specifies the name of the action. The REGISTERED AS construct in the template associates a unique object identifier with this label.

BEHAVIOUR <behaviour-definition-label> [,<behaviour-definition-label>]*
The BEHAVIOUR construct defines the behavior of the action, the parameters that shall be passed to the action, the results the action may generate, and the meaning of the results.
Each <behaviour-definition-label> specifies an instance of use of the Behaviour template.

MODE CONFIRMED
The MODE CONFIRMED construct specifies that an action is confirmed. If this construct is not specified, the choice of whether the action is confirmed is left to the entity acting in the manager role.

PARAMETERS <parameter-label> [<parameter-label>]*
The PARAMETERS construct specifies action information, action reply parameters, or processing information for the action.
Each <parameter-label> specifies the name of a parameter.

WITH INFORMATION SYNTAX type-reference
The WITH INFORMATION SYNTAX construct specifies the action information associated with this type of action.
type-reference defines the data type of the action information. It is a fully qualified reference to a data type defined in an ASN.1 module, that is: ASN.1-Module-Name.data-type-label.

WITH REPLY
SYNTAX type-reference
The WITH REPLY SYNTAX construct specifies the action reply information associated with this type of action.
type-reference defines the data type of the action reply information. It is a fully qualified reference to a data type defined in an ASN.1 module, that is: ASN.1-Module-Name.data-type-label.

REGISTERED AS object-identifier
The REGISTERED AS construct identifies the globally unique identifier assigned to the action.
object-identifier is replaced with the OID that globally and uniquely identifies the action.

C.7 Notification Template

The Notification template defines notifications that can be emitted by a managed object class. A notification can be referenced by more than one managed object class.

The Notification template defines the behavior and syntax of a notification. The syntax definitions specify the contents of the event information and event reply fields in CMIP event report requests and responses.

C.7.1 Notification Template Format

The format of the Notification template is as follows:
<notification-label> NOTIFICATION

    [BEHAVIOUR                 <behaviour-definition-label>

                               [,<behaviour-definition-label>]*;

    ]

    [PARAMETERS                <parameter-label> [<parameter-label>]*;

    ]

    [WITH INFORMATION SYNTAX   type-reference

        [AND ATTRIBUTE IDS        <field-name> <attribute-label>

                                  [,<field-name> <attribute-label>]*

        ] ;

    ]

    [WITH REPLY SYNTAX         type-referenc e;

    ]

REGISTERED AS object-identifier;
C.7.2 Notification Template Constructs

The meaning of each construct in the Notification template is explained in TABLE C-7.

TABLE C-7   Notification Template Constructs
Construct Description

NOTIFICATION <notification-label>
The NOTIFICATION construct identifies the template as a definition for a notification.
<notification-label> specifies the name of the notification. The REGISTERED AS construct in the template associates a unique object identifier with this label.

BEHAVIOUR <behaviour-definition-label> [,<behaviour-definition-label>]*
The BEHAVIOUR construct defines the behavior of the notification, the data that shall be specified with the notification, the results the notification may generate, and the meaning of the results.
Each <behaviour-definition-label> specifies an instance of use of the Behaviour template.

PARAMETERS <parameter-label> [<parameter-label>]*
The PARAMETERS construct specifies event information, event reply parameters, or processing information for the notification.
Each <parameter-label> specifies the name of a parameter.

WITH INFORMATION SYNTAX type-reference [AND ATTRIBUTE IDS <field-name> <attribute-label> [,<field-name> <attribute-label>]*]
The WITH INFORMATION SYNTAX construct specifies the event information associated with this type of notification.
type-reference defines the data type of the action information. It is a fully qualified reference to a data type defined in an ASN.1 module, that is: ASN.1-Module-Name.data-type-label.
The AND ATTRIBUTE IDS option is typically used to specify the attributes contained within a SET or SEQUENCE data type, when a SET or SEQUENCE data type is referenced by the WITH INFORMATION SYNTAX construct.
Each <field-name> specifies a label that is defined within the same ASN.1 module as specified in the WITH INFORMATION SYNTAX construct. The field name label within the ASN.1 module is used to label the data type that specifies the type of the attribute specified by <attribute-label>.
Each <attribute-label> specifies an attribute that is defined within a GDMO module. The definition of this attribute must reference the data type specified by the <field-name>.

WITH REPLY SYNTAX type-reference
The WITH REPLY SYNTAX construct specifies the event reply information associated with this type of notification.
type-reference defines the data type of the event reply information. It is a fully qualified reference to a data type defined in an ASN.1 module, that is: ASN.1-Module-Name.data-type-label.

REGISTERED AS object-identifier
The REGISTERED AS construct identifies the globally unique identifier assigned to the notification.
object-identifier is replaced with the OID that globally and uniquely identifies the notification.

C.8 Parameter Template

The Parameter template defines parameter syntaxes for later inclusion in Package, Attribute, Action, and Notification templates. A parameter can be referenced by one or more of each of these templates.

The Parameter template specifies and registers the parameter syntaxes and associated behavior that may be associated with particular attributes, operations, and notifications within Package, Attribute, Action, and Notification templates. The type specified in a Parameter template is used to fill in the ANY DEFINED BY oid construct.

C.8.1 Parameter Template Format

The format of the Parameter template is as follows:

<parameter-label> PARAMETER

    CONTEXT                    context-type;

    syntax-or-attribute-choice;

    [BEHAVIOUR                <behaviour-definition-label>

                              [,<behaviour-definition-label>]*;

    ]

[REGISTERED AS object-identifier];

C.8.2 Parameter Template Constructs

The meaning of each construct in the Parameter template is explained in TABLE C-8.

TABLE C-8   Parameter Template Constructs
Construct Description

<parameter-label> PARAMETER
The PARAMETER construct identifies the template as a definition for a parameter.
<parameter-label> specifies the name of the parameter. The REGISTERED AS construct in the template associates a unique object identifier with this label.

CONTEXT context-type
The CONTEXT construct identifies the context in which this parameter is applicable.
context-type specifies the context for the parameter definition. context-type can take on one of the following values:
context-keyword - A reference to a context defined externally to the template. context-keyword has the form: type-reference.<identifier>, where type-reference is a fully qualified reference to a data type defined in an ASN.1 module (that is: ASN.1-Module-Name.data-type-label) and <identifier> is the name of one of the fields in that data type.
ACTION-INFO - A CMIS action information parameter.
ACTION-REPLY - A CMIS action reply parameter.
EVENT-INFO - A CMIS event information parameter.
EVENT-REPLY - A CMIS event reply parameter.
SPECIFIC-ERROR - A CMIS processing failure error.

syntax-or-attribute-choice
This construct specifies how the data type associated with the context of the parameter is defined.
syntax-or-attribute-choice is one of the following mutually exclusive options:
ATTRIBUTE <attribute-label> - The syntax and OID of the attribute specified by <attribute-label> are used as the syntax and OID of the parameter.
WITH SYNTAX type-reference - The ASN.1 type of the parameter is that specified by type-reference. type-reference is a fully qualified reference to a data type defined in an ASN.1 module, that is: ASN.1-Module-Name.data-type-label.

BEHAVIOUR <behaviour-definition-label> [,<behaviour-definition-label>]*
The BEHAVIOUR construct specifies any behavior or semantics associated with the parameter. If the ATTRIBUTE construct is used, the BEHAVIOUR construct does not modify the behavior of the attribute.
Each <behaviour-definition-label> specifies an instance of use of the Behaviour template.

REGISTERED AS object-identifier
The REGISTERED AS construct identifies the globally unique identifier assigned to the parameter.
object-identifier is replaced with the OID that globally and uniquely identifies the parameter.

C.9 Attribute Group Template

The Attribute Group template defines one or more attributes that can be referenced as a group. A managed object class definition can include all attributes of a group by referencing the group, rather than referencing each attribute individually. More than one managed object class definition can reference an attribute group.

Attribute groups make it easier to collectively perform operations on a large number of individual attributes.

C.9.1 Attribute Group Template Format

The format of the Attribute Group template is as follows:

<group-label> ATTRIBUTE GROUP

    [GROUP ELEMENTS              <attribute-label> [,<attribute-label>]*;

    ]

    [FIXED;

    ]

    [DESCRIPTION                  delimited-string;

    ]

REGISTERED AS object-identifier;

C.9.2 Attribute Group Template Constructs

The meaning of each construct in the Attribute Group template is explained in TABLE C-9.

TABLE C-9   Attribute Group Template Constructs
Construct Description

<group-label> ATTRIBUTE GROUP
The ATTRIBUTE GROUP construct identifies the template as a definition for an attribute group.
<group-label> specifies the name of the attribute group. The REGISTERED AS construct in the template associates a unique object identifier with this label.

GROUP ELEMENTS <attribute-label> [,<attribute-label>]*
The GROUP ELEMENTS construct specifies the attributes that are members of this attribute group.
Each <attribute-label> specifies an attribute in the group.

FIXED
The FIXED construct limits the membership of the attribute group to only those attributes specified by the GROUP ELEMENTS construct. If the FIXED construct is omitted, the group is made extensible. The group can be extended by adding attributes that are referenced in Package templates.

DESCRIPTION delimited-string
The DESCRIPTION construct provides a description of the semantics of the attribute group, for example 'Group of all state attributes in the managed object'.

REGISTERED AS object-identifier
The REGISTERED AS construct identifies the globally unique identifier assigned to the attribute group.
object-identifier is replaced with the OID that globally and uniquely identifies the attribute group.

C.10 Behaviour Template

The Behaviour template describes the expected behavior of:

Managed object classes
Name bindings
Parameters
Attributes
Actions
Notifications

The behavior may be defined by readable text, high level languages, formal description techniques, references to standard constructs, or by any combination of the preceding definition methods.

C.10.1 Behaviour Template Format

The format of the Behaviour template is as follows:

<behaviour-definition-label> BEHAVIOUR

    [DEFINED AS           ;           delimited-string;

    ]

C.10.2 Behaviour Template Constructs

The meaning of each construct in the Behaviour template is explained in TABLE C-10.

TABLE C-10   Behaviour Template Constructs
Construct Description

BEHAVIOUR <behaviour-definition-label>
The BEHAVIOUR construct identifies the template as a definition for a behavior.
<behaviour-definition-label> specifies the name of the behavior.

DEFINED AS delimited-string
The DEFINED AS construct defines the behavior.
delimited-string contains the text of the behavior.

Construct	Description
<class-label> MANAGED OBJECT CLASS	The MANAGED OBJECT CLASS construct identifies the template as a definition for a managed object class. <class-label> specifies the name of the managed object class. The REGISTERED AS construct in the template associates a unique object identifier with this label.
DERIVED FROM <class-label> [,<class-label>]*	The DERIVED FROM construct identifies other managed object classes that are base classes of the managed object class that is being defined. Each <class-label> specifies a base class of the managed object class that is being defined.
CHARACTERIZED BY <package-label> [,<package-label>]*	The CHARACTERIZED BY construct identifies the packages that the managed object class supports. A package defines a set of behaviors, attributes, operations, and notifications. For detailed information on the contents of a package, see Section C.4 Package Template. Each <package-label> is the name of a package that the managed object class supports.
CONDITIONAL PACKAGES <package-label> PRESENT IF condition-definition [,<package-label> PRESENT IF condition-definition]	The CONDITIONAL PACKAGES construct identifies any packages that are conditionally supported by the managed object class. Each conditional package will be included in a managed object instance if the condition specified by the PRESENT IF clause for the package is true. Each <package-label> is the name of a conditional package. Each condition-definition specifies a condition that must be true for the package to be included in a managed object instance when the instance is created.
REGISTERED AS object-identifier	The REGISTERED AS construct identifies the globally unique identifier assigned to the managed object class. object-identifier is replaced with the object identifier (OID) that globally and uniquely identifies the managed object class.

Construct	Description
<name-binding-label> NAME BINDING	The NAME BINDING construct identifies the template as a definition for a name binding. <name-binding-label> specifies the name of the name binding. The REGISTERED AS construct in the template associates a unique OID with this label.
SUBORDINATE OBJECT CLASS <class-label> [AND SUBCLASSES]	The SUBORDINATE OBJECT CLASS construct identifies a managed object class whose instances can be named by using an instance of the managed object class specified in the NAMED BY SUPERIOR OBJECT CLASS construct. <class-label> identifies the subordinate managed object class. AND SUBCLASSES, if included, specifies that instances of a derived class of the subordinate class can also be named by using an instance of the class specified in the NAMED BY SUPERIOR OBJECT CLASS construct.
NAMED BY SUPERIOR OBJECT CLASS <class-label> [AND SUBCLASSES]	The NAMED BY SUPERIOR OBJECT CLASS construct identifies a managed object class whose instances can be used to name an instance of the managed object class specified in the SUBORDINATE OBJECT CLASS construct. <class-label> identifies the superior managed object class. AND SUBCLASSES, if included, specifies that instances of a derived class of the superior class can also be used to name an instance of the class specified in the SUBORDINATE OBJECT CLASS construct.
WITH ATTRIBUTE <attribute-label>	The WITH ATTRIBUTE construct identifies the attribute that will be used to form the relative distinguished name (RDN) of an instance of the managed object class specified in the SUBORDINATE OBJECT CLASS construct. <attribute-label> identifies the attribute used to form the RDN for an instance of the object class specified by the SUBORDINATE OBJECT CLASS construct. For more information on RDNs, refer to Section 2.2.6.2 Names of Managed Object Instances.
BEHAVIOUR <behaviour-definition-label> [,<behaviour-definition-label>]*	The BEHAVIOUR construct specifies any behavior impact that results specifically due to the use of the name binding. Each <behaviour-definition-label> identifies a behavior as defined in an instance of use of the Behaviour template.
CREATE [create-modifier [,create-modifier]] [<parameter-label>]*	The CREATE construct specifies that an instance of managed object class specified by the SUBORDINATE OBJECT CLASS construct can be created by a management operation (normally a CMIS M-CREATE operation). create-modifier specifies permitted options for an M-CREATE operation. The options are as follows: WITH-REFERENCE-OBJECT - Specifies that a reference object may be specified in an M-CREATE operation WITH-AUTOMATIC-INSTANCE-NAMING - Specifies that the object instance name can be omitted from the M-CREATE operation <parameter-label> identifies name binding error parameters associated with create operations.
DELETE [delete-modifier] [<parameter-label>]*	The DELETE construct specifies that an instance of managed object class specified by the SUBORDINATE OBJECT CLASS construct can be deleted by a management operation (normally a CMIS M-DELETE operation). delete-modifier specifies behavior for a managed object instance when the instance is deleted. The options are as follows: ONLY-IF-NO-CONTAINED-OBJECTS - Specifies that a delete operation will fail and return an error if there are any contained managed object instances under the instance being deleted DELETES-CONTAINED-OBJECTS - Specifies that a delete operation will fail and return an error if any of the managed object instances directly or indirectly under the instance being deleted are subject to the ONLY-IF-NO-CONTAINED-OBJECTS delete modifier <parameter-label> identifies name binding error parameters associated with delete operations.
REGISTERED AS object-identifier	The REGISTERED AS construct identifies the globally unique identifier assigned to the name binding. object-identifier is replaced with the OID that globally and uniquely identifies the name binding.

Construct	Description
<package-label> PACKAGE	The PACKAGE construct identifies the template as a definition for a package. <package-label> specifies the name of the package. The REGISTERED AS construct in the template associates a unique OID with this label.
BEHAVIOUR <behaviour-definition-label> [,<behaviour-definition-label>]*	The BEHAVIOUR construct enables the semantics of the package to be completely described. This construct relates the external view of aspects of a managed object, such as its operations and notifications, to its internal operation. Each <behaviour-definition-label> identifies a behavior as defined in an instance of use of the Behaviour template.
ATTRIBUTES <attribute-label> propertyList [<parameter-label>] [,<attribute-label> propertyList [<parameter-label>]]*	The ATTRIBUTES construct defines operations permitted on a managed object with respect to its attributes. Each <attribute-label> specifies the name of an attribute. Each propertyList specifies the operations permitted on a managed object with respect to the attribute associated with the propertyList. The format of a propertyList is defined in Section C.4.3 PropertyList Supporting Production. Each <parameter-label> specifies an error parameter specific to the managed object class. This parameter is associated with management operations on the attribute.
ATTRIBUTE GROUPS <group-label> [<attribute-label>]* [,<group-label> [<attribute-label>]]	The ATTRIBUTE GROUPS construct enables a set of attribute groups to be identified as part of the package. Each <group-label> specifies the name of an attribute group. Each <attribute-label> specifies the name of an attribute in an attribute group.
ACTIONS <action-label> [<parameter-label>] * [,<action-label> [<parameter-label>]]	The ACTIONS construct specifies a set of action definitions that are included in the package. Each <action-label> specifies the name of an action. Each <parameter-label> specifies the name of an action information, action reply or error parameter.
NOTIFICATIONS <notification-label> [<parameter-label>]* [,<notification-label [<parameter-label>]]	The NOTIFICATIONS construct specifies the notifications that are included in the package. Each <notification-label> specifies the name of a notification. Each <parameter-label> specifies the name of a parameter.
REGISTERED AS object-identifier	The REGISTERED AS construct identifies the globally unique identifier assigned to the package. object-identifier is replaced with the OID that globally and uniquely identifies the package.

Item	Description
REPLACE-WITH-DEFAULT	Specifies that a management operation can set the attribute to a default value. If this property is specified but the DEFAULT VALUE property is not specified, the default value is determined by other means local to the management system.
DEFAULT VALUE value-specifier	Specifies that the attribute has a default value given by value-specifier.
INITIAL VALUE value-specifier	Specifies that the attribute must be set at creation time to the value given by value-specifier.
PERMITTED VALUES type-reference	Specifies that permitted values of the attribute are restricted to those given by type-reference.
REQUIRED VALUES type-reference	Specifies that the attribute shall be able to take any values given by type-reference. This property defines the value set required for conformance.
value-specifier	Specifies the value in a DEFAULT VALUE or INITIAL VALUE property. value-specifier is one of the following: value-reference - The value is a fully qualified reference to a data value defined in an ASN.1 module, that is: ASN.1-Module-Name.data-value-label. DERIVATION RULE <behaviour-definition-label> - The value is determined by the derivation rule specified in <behaviour-definition-label>. <behaviour-definition-label> identifies a behavior as defined in an instance of use of the Behaviour template.
type-reference	Specifies the values in a PERMITTED VALUES or a REQUIRED VALUES property. type-reference is a fully qualified reference to a data type defined in an ASN.1 module, that is: ASN.1-Module-Name.data-type-label.
get-replace	Specifies the management operations allowed on the attribute. get-replace is one of the following: GET - A management operation can read the attribute. REPLACE - A management operation can set the attribute. GET-REPLACE - A management operation can read or set the attribute.
add-remove	Specifies, for a multi-valued attribute only, how a management operation is allowed to add or remove values in the attribute. add-remove is one of the following: ADD - A management operation can add a value to the attribute. REMOVE - A management operation can remove a value from the attribute. ADD-REMOVE - A management operation can add a value to or remove a value from the attribute.
SET-BY-CREATE	Specifies that the attribute may be set by a creation operation (normally a CMIS M-CREATE operation). The SET-BY-CREATE property is meaningful only if the name binding of the managed object instances supports the creation operation.
NO-MODIFY	Specifies that the attribute cannot be modified in the class that has this property and in all subclasses and compatible managed objects. This property is not allowed in a managed object class definition that has the REPLACE, GET-REPLACE, ADD, REMOVE, or ADD-REMOVE properties on the same attribute.

Construct	Description
<attribute-label> ATTRIBUTE	The ATTRIBUTE construct identifies the template as a definition for an attribute. <attribute-label> specifies the name of the attribute. The REGISTERED AS construct in the template associates a unique object identifier with this label.
derived-or-with-syntax-choice	This construct specifies how the attribute is defined. derived-or-with-syntax-choice is one of the following mutually exclusive options: DERIVED FROM <attribute-label> - The attribute is based on the definition referenced by <attribute-label>. WITH ATTRIBUTE SYNTAX <type-reference> - The data type of the attribute is the ASN.1 type specified by <type-reference>.
MATCHES FOR qualifier [,qualifier]*	The MATCHES FOR construct defines the types of tests that may be applied to the value of the attribute by using a filter operation. Each qualifier is one of the following: EQUALITY - The attribute value can be tested for equality against a given value. ORDERING - The attribute value can be tested against a given value to determine which value is greater. SUBSTRINGS - The attribute value can be tested against a given substring to determine if the attribute value is present in the substring. SET-COMPARISON - The attribute value can be tested against a given value to determine if the attribute value is a subset or superset of the given value. SET-INTERSECTION - The attribute value can be tested against a given value to determine if there is a nonnull set intersection between the two values.
BEHAVIOUR <behaviour-definition-label> [,<behaviour-definition-label>]*	The BEHAVIOUR construct specifies behavior that is generic to this attribute. Each <behaviour-definition-label> specifies an instance of use of the Behaviour template.
PARAMETER <parameter-label> [<parameter-label>]*	The PARAMETER construct associates parameters with the behavior of the attribute for the definition of processing failures. Each <parameter-label> specifies a processing failure parameter for the attribute.
REGISTERED AS object-identifier	The REGISTERED AS construct identifies the globally unique identifier assigned to the attribute. object-identifier is replaced with the OID that globally and uniquely identifies the attribute.

Construct	Description
<action-label> ACTION	The ACTION construct identifies the template as a definition for an attribute. <action-label> specifies the name of the action. The REGISTERED AS construct in the template associates a unique object identifier with this label.
BEHAVIOUR <behaviour-definition-label> [,<behaviour-definition-label>]*	The BEHAVIOUR construct defines the behavior of the action, the parameters that shall be passed to the action, the results the action may generate, and the meaning of the results. Each <behaviour-definition-label> specifies an instance of use of the Behaviour template.
MODE CONFIRMED	The MODE CONFIRMED construct specifies that an action is confirmed. If this construct is not specified, the choice of whether the action is confirmed is left to the entity acting in the manager role.
PARAMETERS <parameter-label> [<parameter-label>]*	The PARAMETERS construct specifies action information, action reply parameters, or processing information for the action. Each <parameter-label> specifies the name of a parameter.
WITH INFORMATION SYNTAX type-reference	The WITH INFORMATION SYNTAX construct specifies the action information associated with this type of action. type-reference defines the data type of the action information. It is a fully qualified reference to a data type defined in an ASN.1 module, that is: ASN.1-Module-Name.data-type-label.
WITH REPLY SYNTAX type-reference	The WITH REPLY SYNTAX construct specifies the action reply information associated with this type of action. type-reference defines the data type of the action reply information. It is a fully qualified reference to a data type defined in an ASN.1 module, that is: ASN.1-Module-Name.data-type-label.
REGISTERED AS object-identifier	The REGISTERED AS construct identifies the globally unique identifier assigned to the action. object-identifier is replaced with the OID that globally and uniquely identifies the action.

Construct	Description
NOTIFICATION <notification-label>	The NOTIFICATION construct identifies the template as a definition for a notification. <notification-label> specifies the name of the notification. The REGISTERED AS construct in the template associates a unique object identifier with this label.
BEHAVIOUR <behaviour-definition-label> [,<behaviour-definition-label>]*	The BEHAVIOUR construct defines the behavior of the notification, the data that shall be specified with the notification, the results the notification may generate, and the meaning of the results. Each <behaviour-definition-label> specifies an instance of use of the Behaviour template.
PARAMETERS <parameter-label> [<parameter-label>]*	The PARAMETERS construct specifies event information, event reply parameters, or processing information for the notification. Each <parameter-label> specifies the name of a parameter.
WITH INFORMATION SYNTAX type-reference [AND ATTRIBUTE IDS <field-name> <attribute-label> [,<field-name> <attribute-label>]*]	The WITH INFORMATION SYNTAX construct specifies the event information associated with this type of notification. type-reference defines the data type of the action information. It is a fully qualified reference to a data type defined in an ASN.1 module, that is: ASN.1-Module-Name.data-type-label. The AND ATTRIBUTE IDS option is typically used to specify the attributes contained within a SET or SEQUENCE data type, when a SET or SEQUENCE data type is referenced by the WITH INFORMATION SYNTAX construct. Each <field-name> specifies a label that is defined within the same ASN.1 module as specified in the WITH INFORMATION SYNTAX construct. The field name label within the ASN.1 module is used to label the data type that specifies the type of the attribute specified by <attribute-label>. Each <attribute-label> specifies an attribute that is defined within a GDMO module. The definition of this attribute must reference the data type specified by the <field-name>.
WITH REPLY SYNTAX type-reference	The WITH REPLY SYNTAX construct specifies the event reply information associated with this type of notification. type-reference defines the data type of the event reply information. It is a fully qualified reference to a data type defined in an ASN.1 module, that is: ASN.1-Module-Name.data-type-label.
REGISTERED AS object-identifier	The REGISTERED AS construct identifies the globally unique identifier assigned to the notification. object-identifier is replaced with the OID that globally and uniquely identifies the notification.

Construct	Description
<parameter-label> PARAMETER	The PARAMETER construct identifies the template as a definition for a parameter. <parameter-label> specifies the name of the parameter. The REGISTERED AS construct in the template associates a unique object identifier with this label.
CONTEXT context-type	The CONTEXT construct identifies the context in which this parameter is applicable. context-type specifies the context for the parameter definition. context-type can take on one of the following values: context-keyword - A reference to a context defined externally to the template. context-keyword has the form: type-reference.<identifier>, where type-reference is a fully qualified reference to a data type defined in an ASN.1 module (that is: ASN.1-Module-Name.data-type-label) and <identifier> is the name of one of the fields in that data type. ACTION-INFO - A CMIS action information parameter. ACTION-REPLY - A CMIS action reply parameter. EVENT-INFO - A CMIS event information parameter. EVENT-REPLY - A CMIS event reply parameter. SPECIFIC-ERROR - A CMIS processing failure error.
syntax-or-attribute-choice	This construct specifies how the data type associated with the context of the parameter is defined. syntax-or-attribute-choice is one of the following mutually exclusive options: ATTRIBUTE <attribute-label> - The syntax and OID of the attribute specified by <attribute-label> are used as the syntax and OID of the parameter. WITH SYNTAX type-reference - The ASN.1 type of the parameter is that specified by type-reference. type-reference is a fully qualified reference to a data type defined in an ASN.1 module, that is: ASN.1-Module-Name.data-type-label.
BEHAVIOUR <behaviour-definition-label> [,<behaviour-definition-label>]*	The BEHAVIOUR construct specifies any behavior or semantics associated with the parameter. If the ATTRIBUTE construct is used, the BEHAVIOUR construct does not modify the behavior of the attribute. Each <behaviour-definition-label> specifies an instance of use of the Behaviour template.
REGISTERED AS object-identifier	The REGISTERED AS construct identifies the globally unique identifier assigned to the parameter. object-identifier is replaced with the OID that globally and uniquely identifies the parameter.

Construct	Description
<group-label> ATTRIBUTE GROUP	The ATTRIBUTE GROUP construct identifies the template as a definition for an attribute group. <group-label> specifies the name of the attribute group. The REGISTERED AS construct in the template associates a unique object identifier with this label.
GROUP ELEMENTS <attribute-label> [,<attribute-label>]*	The GROUP ELEMENTS construct specifies the attributes that are members of this attribute group. Each <attribute-label> specifies an attribute in the group.
FIXED	The FIXED construct limits the membership of the attribute group to only those attributes specified by the GROUP ELEMENTS construct. If the FIXED construct is omitted, the group is made extensible. The group can be extended by adding attributes that are referenced in Package templates.
DESCRIPTION delimited-string	The DESCRIPTION construct provides a description of the semantics of the attribute group, for example 'Group of all state attributes in the managed object'.
REGISTERED AS object-identifier	The REGISTERED AS construct identifies the globally unique identifier assigned to the attribute group. object-identifier is replaced with the OID that globally and uniquely identifies the attribute group.

Construct	Description
BEHAVIOUR <behaviour-definition-label>	The BEHAVIOUR construct identifies the template as a definition for a behavior. <behaviour-definition-label> specifies the name of the behavior.
DEFINED AS delimited-string	The DEFINED AS construct defines the behavior. delimited-string contains the text of the behavior.