Table of Contents

Class ObjectDependency

Namespace
CMS.DataEngine
Assembly
CMS.DataEngine.dll

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 cascading deleting when a referenced object is deleted.

public class ObjectDependency : ObjectReference, IDataContainer, ISimpleDataContainer
Inheritance
object
ObjectDependency
Implements
Inherited Members
Extension Methods

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.

Constructors

ObjectDependency(string, string, ObjectDependencyEnum, string)

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

public ObjectDependency(string dependencyColumn, string dependencyObjectType, ObjectDependencyEnum required = ObjectDependencyEnum.NotRequired, string objectTypeColumn = null)

Parameters

dependencyColumn string

The name of the foreign key column that stores the IDs of the referenced objects

dependencyObjectType string

The object type that is the target of the reference (null if the target object type is stored in a data column - use the fourth param to specify the field name)

required ObjectDependencyEnum

Determines how the system handles referential integrity and automatic removal of objects when a referenced object is deleted (Not required reference by default)

objectTypeColumn string

The name of the column that stores the target object type of the reference (null for standard references)

Properties

DependencyType

Determines how the system handles referential integrity and automatic removal of objects when a referenced object is deleted.

[RegisterColumn]
public ObjectDependencyEnum DependencyType { get; set; }

Property Value

ObjectDependencyEnum

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.

[RegisterColumn]
public string ObjectTypeColumn { get; set; }

Property Value

string

Methods

Equals(ObjectDependency)

Compares the dependency with another ObjectDependency object. Returns true if all fields of the two dependencies match.

protected bool Equals(ObjectDependency other)

Parameters

other ObjectDependency

Object to compare

Returns

bool

Equals(object)

Compares the dependency with another object. Returns true if all fields of the two dependencies match.

public override bool Equals(object obj)

Parameters

obj object

Object to compare

Returns

bool

GetHashCode()

Returns the hash code of this object dependency.

public override int GetHashCode()

Returns

int

HasDynamicObjectType()

Returns true if the dependency is referencing a dynamic object type.

public bool HasDynamicObjectType()

Returns

bool

Remarks

Dynamic object type reference lacks any specific DependencyObjectType. It has ObjectTypeColumn defined instead.

Dynamic object type can reference various object types (e.g MetaFiles have column MetaFileObjectType which can hold different object types).