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

System.Object
  CMS.Base.AbstractSimpleDataContainer<ObjectReference>
    CMS.Base.AbstractDataContainer<ObjectReference>
      CMS.DataEngine.ObjectReference
        CMS.DataEngine.ObjectDependency

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 12.0.0

Syntax

public class ObjectDependency : ObjectReference

The ObjectDependency type exposes the following members.

Constructors

	Name	Description
Public method	ObjectDependency	Creates a new ObjectDependency instance, defining a reference (foreign key relationship) from one object type to another.

Properties

	Name	Description
Public property	ColumnNames	Available column names. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public property	DependencyColumn	Gets or sets the name of the reference column that stores the IDs of the referenced objects. (Inherited from ObjectReference.)
Public property	DependencyObjectType	Gets or sets the object type that is the target of the reference. (Inherited from ObjectReference.)
Public property	DependencyType	Determines how the system handles referential integrity and automatic removal of objects when a referenced object is deleted.
Public property	Item	Gets or sets the value of the column. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public property	ObjectTypeColumn	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 property	RegisteredColumns	Registered Columns (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	RegisteredColumnsObject	Registered Columns object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	UseLocalColumns	If true, the object uses local columns (Inherited from AbstractSimpleDataContainer<TObject>.)

Methods

	Name	Description
Public method	ContainsColumn	Returns true if specified column is available in current structure. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public method	Equals(Object)	Compares the dependency with another object. Returns true if all fields of the two dependencies match. (Overrides Object.Equals(Object).)
Protected method	Equals(ObjectDependency)	Compares the dependency with another ObjectDependency object. Returns true if all fields of the two dependencies match.
Public method	GetHashCode	Returns the hash code of this object dependency. (Overrides Object.GetHashCode().)
Public method	GetValue	Gets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method	HasDynamicObjectType	Returns true if the dependency is referencing a dynamic object type.
Protected method	RegisterColumn(String, Func<TObject, Object>)	Registers the given Column to the object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterColumn(String, Func<TObject, Object>, Func<TObject, Object, Object>)	Registers the given Column to the object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterColumns	Registers the Columns of this object (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method	SetValue	Sets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method	TryGetValue	Returns value of column. (Inherited from AbstractSimpleDataContainer<TObject>.)

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.