FDO .NET API Reference Feature Data Objects
Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

OSGeo::FDO::Schema::ObjectPropertyDefinition Class Reference

Inherits OSGeo::FDO::Schema::PropertyDefinition.

Inheritance diagram for OSGeo::FDO::Schema::ObjectPropertyDefinition:

[legend]
List of all members.

Detailed Description

ObjectPropertyDefinition class derives PropertyDefinition 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.


Public Member Functions

__property OSGeo::FDO::Schema::ClassDefinitionget_Class ()
 Gets a reference to the ClassDefinition that defines the type of this property.
__property OSGeo::FDO::Schema::DataPropertyDefinitionget_IdentityProperty ()
 Gets a reference to an DataPropertyDefinition to use for uniquely identifying instances of the contained class within a single parent object instance. This value is only used for ObjectType_Collection and ObjectType_OrderedCollection object property types. The DataPropertyDefinition must belong to the ClassDefinition that defines the type of this property.
__property OSGeo::FDO::Schema::ObjectType get_ObjectType ()
 Gets the type of this object property (value, collection, or ordered collection).
__property OSGeo::FDO::Schema::OrderType get_OrderType ()
 Gets the order type of this object property (ascending or descending). This property is only applicable if the property type is set to ObjectType_OrderedCollection.
 ObjectPropertyDefinition (System::IntPtr unmanaged, System::Boolean autoDelete)
 Constructs a ObjectPropertyDefinition object based on an unmanaged instance of the object.
 ObjectPropertyDefinition (System::String *name, System::String *description, System::Boolean system)
 Constructs an instance of an ObjectPropertyDefinition using the specified arguments.
 ObjectPropertyDefinition (System::String *name, System::String *description)
 Constructs an instance of an ObjectPropertyDefinition using the specified arguments.
 ObjectPropertyDefinition ()
 Constructs a default instance of an ObjectPropertyDefinition.
__property System::Void set_Class (OSGeo::FDO::Schema::ClassDefinition *value)
 Sets a reference to the ClassDefinition that defines the type of this property.
__property System::Void set_IdentityProperty (OSGeo::FDO::Schema::DataPropertyDefinition *value)
 Sets a reference to an DataPropertyDefinition to use for uniquely identifying instances of the contained class within a single parent object instance. This value is only used for ObjectType_Collection and ObjectType_OrderedCollection object property types. The DataPropertyDefinition must belong to the ClassDefinition that defines the type of this property.
__property System::Void set_ObjectType (OSGeo::FDO::Schema::ObjectType value)
 Sets the type of this object property (value, collection, or ordered collection).
__property System::Void set_OrderType (OSGeo::FDO::Schema::OrderType value)
 Sets the order type of this object property (ascending or descending). This property is only applicable if the property type is set to ObjectType_OrderedCollection.

Constructor & Destructor Documentation

OSGeo::FDO::Schema::ObjectPropertyDefinition::ObjectPropertyDefinition  ) 
 

Constructs a default instance of an ObjectPropertyDefinition.

OSGeo::FDO::Schema::ObjectPropertyDefinition::ObjectPropertyDefinition System::String *  name,
System::String *  description
 

Constructs an instance of an ObjectPropertyDefinition using the specified arguments.

Parameters:
name Input name
description Input description

OSGeo::FDO::Schema::ObjectPropertyDefinition::ObjectPropertyDefinition System::String *  name,
System::String *  description,
System::Boolean  system
 

Constructs an instance of an ObjectPropertyDefinition 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.

OSGeo::FDO::Schema::ObjectPropertyDefinition::ObjectPropertyDefinition System::IntPtr  unmanaged,
System::Boolean  autoDelete
[inline]
 

Constructs a ObjectPropertyDefinition object based on an unmanaged instance of the object.

Parameters:
unmanaged Input A Pointer to the unmanaged object.
autoDelete Input Indicates if the constructed object should be automatically deleted once it no longer referenced.

Member Function Documentation

__property OSGeo ::FDO ::Schema ::ClassDefinition* OSGeo::FDO::Schema::ObjectPropertyDefinition::get_Class  ) 
 

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

Returns:
Returns class definition

__property OSGeo ::FDO ::Schema ::DataPropertyDefinition* OSGeo::FDO::Schema::ObjectPropertyDefinition::get_IdentityProperty  ) 
 

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

Returns:
Returns the Indentity data property definition

__property OSGeo ::FDO ::Schema ::ObjectType OSGeo::FDO::Schema::ObjectPropertyDefinition::get_ObjectType  ) 
 

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

Returns:
Returns the type of this object property

__property OSGeo ::FDO ::Schema ::OrderType OSGeo::FDO::Schema::ObjectPropertyDefinition::get_OrderType  ) 
 

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

Returns:
Returns the order type

__property System::Void OSGeo::FDO::Schema::ObjectPropertyDefinition::set_Class OSGeo::FDO::Schema::ClassDefinition value  ) 
 

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

Parameters:
value Input class definition

__property System::Void OSGeo::FDO::Schema::ObjectPropertyDefinition::set_IdentityProperty OSGeo::FDO::Schema::DataPropertyDefinition value  ) 
 

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

Parameters:
value Input data property definition

__property System::Void OSGeo::FDO::Schema::ObjectPropertyDefinition::set_ObjectType OSGeo::FDO::Schema::ObjectType  value  ) 
 

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

Parameters:
value Input the type of this object property

__property System::Void OSGeo::FDO::Schema::ObjectPropertyDefinition::set_OrderType OSGeo::FDO::Schema::OrderType  value  ) 
 

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

Parameters:
value Input the order type

Comments or suggestions? Send us feedback.