OMBDEFINE CLASS_DEFINITION

Purpose

To define a class (user defined object type).

Prerequisites

Class definition to be defined should not already exist.

Syntax

parseDefineClassCommand =  OMBDEFINE [ ( FIRST_CLASS_OBJECT | 
          SECOND_CLASS_OBJECT | FOLDER | MODULE ) ] CLASS_DEFINITION 
          "QUOTED_STRING" [ ( ON | OF ) "modelClause" ] [ ( 
          "setClassDefinitionPropertiesClause" | 
          "setClassDefinitionIconSetClause" ) ] [ "addSubDefinitionsClause" ]
     modelClause =  ( MODEL "QUOTED_STRING" | PLATFORM "QUOTED_STRING" | 
          CONFIGURATION_TEMPLATE "QUOTED_STRING" ( ON | OF ) PLATFORM 
          "QUOTED_STRING" )
     setClassDefinitionPropertiesClause =  SET PROPERTIES "(" "propertyNameList"
           ")" VALUES "(" "propertyValueList" ")"
     setClassDefinitionIconSetClause =  SET REF ICONSET "QUOTED_STRING"
     addSubDefinitionsClause =  ( "addPropertyDefinitionClause" | 
          "addPropertyGroupDefinitionClause" | "addChildTypeClause" )+
     propertyNameList =  "propertyNameClause" { "," "propertyNameClause" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     addPropertyDefinitionClause =  ( ADD [ ( ( CONFIGURATION | 
          PHYSICAL_CONFIGURATION ) | LOGICAL | USER_DEFINED ) ] 
          PROPERTY_DEFINITION "QUOTED_STRING" 
          "setPropertyDefinitionPropertiesClause" )
     addPropertyGroupDefinitionClause =  ADD PROPERTY_GROUP_DEFINITION 
          "QUOTED_STRING" "setPropertyGroupDefinitionPropertiesClause"
     addChildTypeClause =  ( ADD CHILD_TYPE "QUOTED_STRING" )
     propertyNameClause =  ( "UNQUOTED_STRING" )
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" | 
          "FLOATING_POINT_LITERAL" )
     setPropertyDefinitionPropertiesClause =  SET PROPERTIES "(" 
          "propertyNameList" ")" VALUES "(" "propertyValueList" ")"
     setPropertyGroupDefinitionPropertiesClause =  SET PROPERTIES "(" 
          "propertyNameList" ")" VALUES "(" "propertyValueList" ")"

Parameters

parseDefineClassCommand

Define a class.

FOLDER

Class definition is folder.

MODULE

Class definition is module.

QUOTED_STRING

Name of the class.

setClassDefinitionPropertiesClause

Set the properties on the class definition. Valid properties are BUSINESS_NAME, DESCRIPTION, DISPLAY_NAME, PLURAL_NAME.

setClassDefinitionIconSetClause

Assign an icon to the class definition.

propertyNameList

The list of property names.

propertyValueList

The list of values.

addPropertyDefinitionClause

Add a property definition to the class definition.

addPropertyGroupDefinitionClause

Add a property group definition to the class definition.

addChildTypeClause

Add a aggregate child type to the class definition.

propertyNameClause

The name of the property.

UNQUOTED_STRING

The name of the property for the class definition.

propertyValue

The value of the property.

QUOTED_STRING

The value in string format of the property for the class definition.

INTEGER_LITERAL

The integer value of the property for the class definition.

FLOATING_POINT_LITERAL

The float value of the property for the class definition.

setPropertyDefinitionPropertiesClause

Set the properties for the property definition. Valid properties are TYPE, DEFAULT_VALUE, POSITION, HIDDEN.

See Also

OMBDESCRIBE CLASS_DEFINITION