FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoObjectPropertyDefinition Class Reference

#include <ObjectPropertyDefinition.h>

Inherits FdoPropertyDefinition.

Inheritance diagram for FdoObjectPropertyDefinition:

[legend]
List of all members.

Detailed Description

The FdoObjectPropertyDefinition class derives from FdoPropertyDefinition and represents containment of an object or a collection of objects within another class. The class of the contained object must already be defined in the feature schema and cannot be abstract.

Definition at line 38 of file ObjectPropertyDefinition.h.


Public Member Functions

virtual void _writeXml (FdoSchemaXmlContext *pContext)
 Serialize this property to XML.
virtual void CheckReferences (FdoSchemaMergeContext *pContext)
FDO_API FdoClassDefinitionGetClass ()
 Gets a reference to the FdoClassDefinition that defines the type of this property.
FDO_API FdoDataPropertyDefinitionGetIdentityProperty ()
 Gets a reference to an FdoDataPropertyDefinition to use for uniquely identifying instances of the contained class within a single parent object instance. This value is only used for the FdoObjectType_Collection and FdoObjectType_OrderedCollection object property types. The FdoDataPropertyDefinition must belong to the FdoClassDefinition that defines the type of this property.
FDO_API FdoObjectType GetObjectType ()
 Gets the type of this object property (value, collection, or ordered collection).
FDO_API FdoOrderType GetOrderType ()
 Gets the order type of this object property (ascending or descending). This property is only applicable if the property type is set to FdoObjectType_OrderedCollection.
virtual FDO_API FdoPropertyType GetPropertyType ()
 Gets the concrete property type.
virtual void InitFromXml (FdoString *propertyTypeName, FdoSchemaXmlContext *pContext, FdoXmlAttributeCollection *attrs)
 Initialize this property from its XML attributes.
virtual void Set (FdoPropertyDefinition *pProperty, FdoSchemaMergeContext *pContext)
 DOXYGEN-IGNORE
FDO_API void SetClass (FdoClassDefinition *value)
 Sets a reference to the FdoClassDefinition that defines the type of this property.
FDO_API void SetIdentityProperty (FdoDataPropertyDefinition *value)
 Sets a reference to an FdoDataPropertyDefinition to use for uniquely identifying instances of the contained class within a single parent object instance. This value is only used for the FdoObjectType_Collection and FdoObjectType_OrderedCollection object property types. The FdoDataPropertyDefinition must belong to the FdoClassDefinition that defines the type of this property.
FDO_API void SetObjectType (FdoObjectType value)
 Sets the type of this object property (value, collection, or ordered collection).
FDO_API void SetOrderType (FdoOrderType value)
 Sets the order type of this object property (ascending or descending). This property is only applicable if the property type is set to FdoObjectType_OrderedCollection.

Static Public Member Functions

FDO_API FdoObjectPropertyDefinitionCreate (FdoString *name, FdoString *description, bool system=false)
 Constructs an instance of an FdoObjectPropertyDefinition using the specified arguments.
FDO_API FdoObjectPropertyDefinitionCreate ()
 Constructs a default instance of an FdoObjectPropertyDefinition.

Protected Member Functions

virtual void _AcceptChanges ()
virtual void _BeginChangeProcessing ()
virtual void _EndChangeProcessing ()
virtual void _RejectChanges ()
virtual void _StartChanges ()
 FdoFeatureSchema::RejectChanges() support.
virtual void Dispose ()
 Dispose this object.
FDO_API FdoObjectPropertyDefinition (FdoString *name, FdoString *description, bool system=false)
FDO_API FdoObjectPropertyDefinition ()
 Constructs a default instance of an FdoObjectPropertyDefinition.
virtual ~FdoObjectPropertyDefinition ()
 DOXYGEN-IGNORE

Protected Attributes

FdoClassDefinitionm_classCHANGED
FdoDataPropertyDefinitionm_identityPropertyCHANGED
FdoObjectType m_objectTypeCHANGED
FdoOrderType m_orderTypeCHANGED

Constructor & Destructor Documentation

FDO_API FdoObjectPropertyDefinition::FdoObjectPropertyDefinition  )  [protected]
 

Constructs a default instance of an FdoObjectPropertyDefinition.

FDO_API FdoObjectPropertyDefinition::FdoObjectPropertyDefinition FdoString name,
FdoString description,
bool  system = false
[protected]
 

Constructs an instance of an FdoObjectPropertyDefinition using the specified arguments.

virtual FdoObjectPropertyDefinition::~FdoObjectPropertyDefinition  )  [protected, virtual]
 

DOXYGEN-IGNORE


Member Function Documentation

virtual void FdoObjectPropertyDefinition::_AcceptChanges  )  [protected, virtual]
 

Reimplemented from FdoSchemaElement.

virtual void FdoObjectPropertyDefinition::_BeginChangeProcessing  )  [protected, virtual]
 

Reimplemented from FdoSchemaElement.

virtual void FdoObjectPropertyDefinition::_EndChangeProcessing  )  [protected, virtual]
 

Reimplemented from FdoSchemaElement.

virtual void FdoObjectPropertyDefinition::_RejectChanges  )  [protected, virtual]
 

Reimplemented from FdoSchemaElement.

virtual void FdoObjectPropertyDefinition::_StartChanges  )  [protected, virtual]
 

FdoFeatureSchema::RejectChanges() support.

Reimplemented from FdoSchemaElement.

virtual void FdoObjectPropertyDefinition::_writeXml FdoSchemaXmlContext *  pContext  )  [virtual]
 

Serialize this property to XML.

Reimplemented from FdoPropertyDefinition.

virtual void FdoObjectPropertyDefinition::CheckReferences FdoSchemaMergeContext pContext  )  [virtual]
 

Reimplemented from FdoSchemaElement.

FDO_API FdoObjectPropertyDefinition* FdoObjectPropertyDefinition::Create FdoString name,
FdoString description,
bool  system = false
[static]
 

Constructs an instance of an FdoObjectPropertyDefinition using the specified arguments.

Parameters:
name Input name
description Input description
system Input true if this is a system generated property, otherwise false.
Note:
A client would never set system to true, only a provider.
Returns:
Returns FdoObjectPropertyDefinition

FDO_API FdoObjectPropertyDefinition* FdoObjectPropertyDefinition::Create  )  [static]
 

Constructs a default instance of an FdoObjectPropertyDefinition.

Returns:
Returns FdoObjectPropertyDefinition

virtual void FdoObjectPropertyDefinition::Dispose  )  [protected, virtual]
 

Dispose this object.

Returns:
Returns nothing

Implements FdoIDisposable.

FDO_API FdoClassDefinition* FdoObjectPropertyDefinition::GetClass  ) 
 

Gets a reference to the FdoClassDefinition that defines the type of this property.

Returns:
Returns class definition

FDO_API FdoDataPropertyDefinition* FdoObjectPropertyDefinition::GetIdentityProperty  ) 
 

Gets a reference to an FdoDataPropertyDefinition to use for uniquely identifying instances of the contained class within a single parent object instance. This value is only used for the FdoObjectType_Collection and FdoObjectType_OrderedCollection object property types. The FdoDataPropertyDefinition must belong to the FdoClassDefinition that defines the type of this property.

Returns:
Returns data property definition

FDO_API FdoObjectType FdoObjectPropertyDefinition::GetObjectType  ) 
 

Gets the type of this object property (value, collection, or ordered collection).

Returns:
Returns the type of this object property

FDO_API FdoOrderType FdoObjectPropertyDefinition::GetOrderType  ) 
 

Gets the order type of this object property (ascending or descending). This property is only applicable if the property type is set to FdoObjectType_OrderedCollection.

Returns:
Returns the order type

virtual FDO_API FdoPropertyType FdoObjectPropertyDefinition::GetPropertyType  )  [virtual]
 

Gets the concrete property type.

Returns:
Returns the concrete property type

Implements FdoPropertyDefinition.

virtual void FdoObjectPropertyDefinition::InitFromXml FdoString propertyTypeName,
FdoSchemaXmlContext *  pContext,
FdoXmlAttributeCollection attrs
[virtual]
 

Initialize this property from its XML attributes.

Reimplemented from FdoPropertyDefinition.

virtual void FdoObjectPropertyDefinition::Set FdoPropertyDefinition pProperty,
FdoSchemaMergeContext pContext
[virtual]
 

DOXYGEN-IGNORE

Reimplemented from FdoPropertyDefinition.

FDO_API void FdoObjectPropertyDefinition::SetClass FdoClassDefinition value  ) 
 

Sets a reference to the FdoClassDefinition that defines the type of this property.

Parameters:
value Input class definition
Returns:
Returns nothing

FDO_API void FdoObjectPropertyDefinition::SetIdentityProperty FdoDataPropertyDefinition value  ) 
 

Sets a reference to an FdoDataPropertyDefinition to use for uniquely identifying instances of the contained class within a single parent object instance. This value is only used for the FdoObjectType_Collection and FdoObjectType_OrderedCollection object property types. The FdoDataPropertyDefinition must belong to the FdoClassDefinition that defines the type of this property.

Parameters:
value Input data property definition
Returns:
Returns nothing

FDO_API void FdoObjectPropertyDefinition::SetObjectType FdoObjectType  value  ) 
 

Sets the type of this object property (value, collection, or ordered collection).

Parameters:
value Input the type of this object property
Returns:
Returns nothing

FDO_API void FdoObjectPropertyDefinition::SetOrderType FdoOrderType  value  ) 
 

Sets the order type of this object property (ascending or descending). This property is only applicable if the property type is set to FdoObjectType_OrderedCollection.

Parameters:
value Input the order type
Returns:
Returns nothing

Member Data Documentation

FdoClassDefinition* FdoObjectPropertyDefinition::m_classCHANGED [protected]
 

Definition at line 211 of file ObjectPropertyDefinition.h.

FdoDataPropertyDefinition* FdoObjectPropertyDefinition::m_identityPropertyCHANGED [protected]
 

Definition at line 214 of file ObjectPropertyDefinition.h.

FdoObjectType FdoObjectPropertyDefinition::m_objectTypeCHANGED [protected]
 

Definition at line 212 of file ObjectPropertyDefinition.h.

FdoOrderType FdoObjectPropertyDefinition::m_orderTypeCHANGED [protected]
 

Definition at line 213 of file ObjectPropertyDefinition.h.


The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.