Click or drag to resize
ObjectDependency Class
Represents a reference (foreign key relationship) from one object type to another. Defines how the system handles dependencies for the reference. For example data integrity during import and staging, or cascading deleting when a referenced object is deleted.
Inheritance Hierarchy
SystemObject
  CMS.BaseAbstractSimpleDataContainerObjectReference
    CMS.BaseAbstractDataContainerObjectReference
      CMS.DataEngineObjectReference
        CMS.DataEngineObjectDependency

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 12.0.0
Syntax
C#
public class ObjectDependency : ObjectReference

The ObjectDependency type exposes the following members.

Constructors
  NameDescription
Public methodObjectDependency
Creates a new ObjectDependency instance, defining a reference (foreign key relationship) from one object type to another.
Top
Properties
  NameDescription
Public propertyColumnNames
Available column names.
(Inherited from AbstractDataContainerParentObjectType.)
Public propertyDependencyColumn
Gets or sets the name of the reference column that stores the IDs of the referenced objects.
(Inherited from ObjectReference.)
Public propertyDependencyObjectType
Gets or sets the object type that is the target of the reference.
(Inherited from ObjectReference.)
Public propertyDependencyType
Determines how the system handles referential integrity and automatic removal of objects when a referenced object is deleted.
Public propertyItem
Gets or sets the value of the column.
(Inherited from AbstractSimpleDataContainerTObject.)
Public propertyObjectTypeColumn
Gets or sets the name of the data column that stores the target object type of the reference (for objects without FK database restrictions). For example ObjectSettings or Metafiles where the object dependency is a combination of MetaFileObjectType and MetaFileObjectID.
Protected propertyRegisteredColumns
Registered Columns
(Inherited from AbstractSimpleDataContainerTObject.)
Protected propertyRegisteredColumnsObject
Registered Columns object
(Inherited from AbstractSimpleDataContainerTObject.)
Protected propertyUseLocalColumns
If true, the object uses local columns
(Inherited from AbstractSimpleDataContainerTObject.)
Top
Methods
  NameDescription
Public methodContainsColumn
Returns true if specified column is available in current structure.
(Inherited from AbstractDataContainerParentObjectType.)
Public methodEquals(Object)
Compares the dependency with another object. Returns true if all fields of the two dependencies match.
(Overrides ObjectEquals(Object).)
Protected methodEquals(ObjectDependency)
Compares the dependency with another ObjectDependency object. Returns true if all fields of the two dependencies match.
Public methodGetHashCode
Returns the hash code of this object dependency.
(Overrides ObjectGetHashCode.)
Public methodGetValue
Gets the object value.
(Inherited from AbstractSimpleDataContainerTObject.)
Public methodHasDynamicObjectType
Returns true if the dependency is referencing a dynamic object type.
Protected methodRegisterColumn(String, FuncTObject, Object)
Registers the given Column to the object
(Inherited from AbstractSimpleDataContainerTObject.)
Protected methodRegisterColumn(String, FuncTObject, Object, FuncTObject, Object, Object)
Registers the given Column to the object
(Inherited from AbstractSimpleDataContainerTObject.)
Protected methodRegisterColumns
Registers the Columns of this object
(Inherited from AbstractSimpleDataContainerTObject.)
Public methodSetValue
Sets the object value.
(Inherited from AbstractSimpleDataContainerTObject.)
Public methodTryGetValue
Returns value of column.
(Inherited from AbstractSimpleDataContainerTObject.)
Top
Remarks
Use List collections of ObjectDependency instances to set the DependsOn property of ObjectTypeInfo. Each ObjectDependency in the collection registers a foreign key field as a reference pointing from the given object type to another.
See Also