OMBDESCRIBE ASSOCIATION_DEFINITION

Purpose

To describe an association definition.

Prerequisites

Association definition must be already exist. This command can be executed for any association definition regardless of current context.

Syntax

parseDescribeAssociationCommand =  OMBDESCRIBE ASSOCIATION_DEFINITION 
          "QUOTED_STRING" [ ( ON | OF ) "modelClause" ] ( GET ( 
          "getAssociationPropertiesClause" | DEPENDENCY_DEFINITIONS ) | ( 
          DEPENDENCY_DEFINITION "QUOTED_STRING" GET 
          "getDependencyPropertiesClause" ) )
     modelClause =  ( MODEL "QUOTED_STRING" | PLATFORM "QUOTED_STRING" | 
          CONFIGURATION_TEMPLATE "QUOTED_STRING" ( ON | OF ) PLATFORM 
          "QUOTED_STRING" )
     getAssociationPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getDependencyPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     propertyNameList =  "propertyNameClause" { "," "propertyNameClause" }
     propertyNameClause =  ( "UNQUOTED_STRING" )

Parameters

parseDescribeAssociationCommand

Describe an association definition.

getAssociationPropertiesClause

Basic properties for ASSOCIATION_DEFINITION: 

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: N/A
A descriptive text for this association.

Name: CLASS_1 
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: N/A
Class on one side of the association.

NAME: CLASS_2 
Type: STRING(200) 
Value Values: N/A
Default: N/A
Class on the other side of the association.

Name: ROLE_1
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: N/A
Role on one side of the association. 

Name: ROLE_2
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: N/A
Role on the other side of the association. 

Name: ROLE_1_MIN_CARDINALITY
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: N/A
Minimum cardinality of role 1. Value can be positive integer.

Name: ROLE_1_MAX_CARDINALITY
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: N/A
Maximum cardinality of role 1. Value can be positive integer or 'INFINITE'.

Name: ROLE_1_NAVIGABLE
Type: BOOLEAN 
Valid Values: true, false
Default: From user defined class side default is true. From OWB class side default is false.
Navigability of role 1. 

Name: ROLE_2_MIN_CARDINALITY
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: N/A
Minimum cardinality of role 2. Value can be positive integer.

Name: ROLE_2_MAX_CARDINALITY
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: N/A
Maximum cardinality of role 2. Value can be positive integer or 'INFINITE'.

Name: ROLE_2_NAVIGABLE
Type: BOOLEAN 
Valid Values: true, false
Default: From user defined class side default is true. From OWB class side default is false.
Navigability of role 2.

getDependencyPropertiesClause

Basic dependency-related properties for this association:

Name: SOURCE_ROLE_ID

Type: STRING(200)

Valid Values: ROLE_1, ROLE_2

Default: If one of the ends is a OWB class, then that is the default source. If both ends are user defined classes, then the association is default bidirectional.

Identifies the role (end) of the association which serves as the source for the dependency flow.

Name: BIDIRECTIONAL

Type: BOOLEAN

Valid Values: true, false

Default: If one of the ends is a OWB class, then default is false. If both ends are user defined classes, then default is true.

Specifies whether the association is bi-directional for the dependency flow.

propertyNameList

The list of property names.

propertyNameClause

Name of a property.