dmaClass_PropertyDescription

A metadata class object describing a property.

Class ID: dmaClass_PropertyDescription
Superclass: Metadata

Interfaces

Properties

Name	Impl. Required	System Gen'ed	Read-Only	Value Required	Type	Cardinality	Required Class
OIID	-	Yes	Yes	-	String	Scalar
Class Description	Yes	Yes	Yes	Yes	Object	Scalar	Class Description
This	-	Yes	Yes	Yes	Object	Scalar	Property Description
Create Pending	-	Yes	Yes	Yes	Boolean	Scalar
Update Pending	-	Yes	Yes	Yes	Boolean	Scalar
Delete Pending	-	Yes	Yes	Yes	Boolean	Scalar
Display Name	Yes	-	-	Yes	String	Scalar
Descriptive Text	Yes	-	-	Yes	String	Scalar
Ids	Yes	-	-	Yes	ID	List
Data Type	Yes	Yes	Yes	Yes	Integer32	Scalar
Cardinality	Yes	-	-	Yes	Integer32	Scalar
Is Selectable	Yes	-	-	Yes	Boolean	Scalar
Is Searchable	Yes	-	-	Yes	Boolean	Scalar
Is Orderable	Yes	-	-	Yes	Boolean	Scalar
Query Operator Descriptions	Yes	-	-	-	Object	List	Query Operator Description
Is System Generated	Yes	-	-	Yes	Boolean	Scalar
Is Read Only	Yes	-	-	Yes	Boolean	Scalar
Is Value Required	Yes	-	-	Yes	Boolean	Scalar
Is Hidden	Yes	-	-	Yes	Boolean	Scalar

Detailed Description

Each instance of a Property Description object describes a specific property for a single class, and is an element of the dmaProp_PropertyList property of a Class Description object for that class. There is information provided in this object to enable applications to request appropriate data from users (for example, length, min/max, selection lists).

Property Descriptions

• OIID {dmaProp_OIID}
Property Inherited from DMA

• Class Description {dmaProp_ClassDescription}
Property Inherited from DMA

• This {dmaProp_This}
Property Inherited from DMA

• Create Pending {dmaProp_CreatePending}
Property Inherited from DMA

• Update Pending {dmaProp_UpdatePending}
Property Inherited from DMA

• Delete Pending {dmaProp_DeletePending}
Property Inherited from DMA

• Display Name {dmaProp_DisplayName}
Property Inherited from Metadata

• Descriptive Text {dmaProp_DescriptiveText}
Property Inherited from Metadata

• Ids {dmaProp_Ids}
Property Inherited from Metadata

• Data Type {dmaProp_DataType}

The data type of the property, an enumeration.

The DMA data types (in order) are: DmaBinary, DmaBoolean, DmaDateTime, DmaFloat64, DmaId, DmaInteger32, DmaObject, DmaOIID, and DmaString.

The defined symbols for dmaProp_DataType property values for Element Data Type are DMA_DATATYPE_BINARY, DMA_DATATYPE_BOOLEAN, DMA_DATATYPE_DATETIME, DMA_DATATYPE_FLOAT64, DMA_DATATYPE_ID, DMA_DATATYPE_INTEGER32, DMA_DATATYPE_OBJECT, DMA_DATATYPE_STRING, and DMA_DATATYPE_STRING for specifying the respective data types.

• Cardinality {dmaProp_Cardinality}

The value of this property indicates the cardinality of the property being described: scalar, list or enumeration.

• Is Selectable {dmaProp_IsSelectable}

A boolean specifying whether the class or property can be selected in a query result set.

• Is Searchable {dmaProp_IsSearchable}

A boolean specifying whether the class or property can be used as part of the search criteria.

• Is Orderable {dmaProp_IsOrderable}

If True, this property can appear in the Orderings list of a query.

• Query Operator Descriptions {dmaProp_QueryOperatorDescriptions}

A list of query operator descriptions that this property might legally be an operand of.

• Is System Generated {dmaProp_IsSystemGenerated}

If TRUE, indicates that this property is generated and set by the DMA system, usually as a result of some other object's existence.

• Is Read Only {dmaProp_IsReadOnly}

For a singleton property, a setting of TRUE implies that the methods of IdmaEditProperties will fail when applied to this property.

For a list property, a setting of TRUE implies that a list object obtained from this property will not be modifiable, i.e. that the methods of IdmaEditListOfXXXX will fail. The methods of IdmaEditProperties always fail on a list property, regardless of the value of this metaproperty.

For an enumeration property, the value of this metaproperty is irrelevant. The methods of IdmaEditProperties always fail on an enumeration property and there are no modification methods on an enumeration object.

• Is Value Required {dmaProp_IsValueRequired}

If TRUE, indicates that every instance of the described property must have a value.

For a list or enumeration property, this means that the list or enumeration must have at least one element. (A list or enumeration object is always present in the property, irrespective of the setting of Is Value Required.)

• Is Hidden {dmaProp_IsHidden}

Hidden property for display to administrative users

If TRUE, denotes a "system" property that should not be displayed to non-administrative users.