Relationship Object Members

 BoundAttachments

Get all the BoundAttachments of this Relationship.

 ChildAction

Returns the child action of the given type. The action types are 'INSERT', 'UPDATE' or 'DELETE'. The return action names are 'NONE', 'RESTRICT', 'CASCADE', 'SETNULL' or 'SETDEFAULT'. PARAMETERS: ActionType as String. RETURN DATATYPE: String.

 FKColumnPairs

Returns an object representing a collection of all foreign key column pairs maintained by the relationship.

 ParentAction

Returns the parent action of the given type. The action types are 'INSERT', 'UPDATE' or 'DELETE'. The return action names are 'NONE', 'RESTRICT', 'CASCADE', 'SETNULL' or 'SETDEFAULT'. PARAMETERS: ActionType as String. RETURN DATATYPE: String.

 RepoCheckOutStatus

Get the Check Out status of this Relationship object. DATATYPE: StringObjects.

 RepoVersionHistory

Get the Version History of this Relationship from the Repository server. Return the data in the StringObjects collection. DATATYPE: StringObjects.

 SetChildAction

Sets the child action of the given type with the given action. The action types are 'INSERT', 'UPDATE' or 'DELETE'. The action names are 'NONE', 'RESTRICT', 'CASCADE', 'SETNULL' or 'SETDEFAULT'. PARAMETERS: ActionType as String, ActionName as String.

 SetParentAction

Sets the parent action of the given type with the given action. The action types are 'INSERT', 'UPDATE' or 'DELETE'. The action names are 'NONE', 'RESTRICT', 'CASCADE', 'SETNULL' or 'SETDEFAULT'. PARAMETERS:ActionType as String, ActionName as String.

 UserComments

Returns a collection of user comments associated with this Relationship.

 BusinessName

This is the business name of the relationship. DATATYPE: String.

 CardinalityNo

This is the Child Cardinality No of the relationship: Zero or One to Zero or More = 0, Zero or One to One or More = 1, Zero or One to Zero or One = 2, Zero or One to exactly N = 3. DATATYPE: Integer.

 CardinalityValue

This is the Cardinality Value of the relationship when the Cardinality No is 3 (Zero or One to exactly N). DATATYPE: Integer.

 ChildEntity

This is the child entity of the relationship.

 DB2OSNotEnforced

This property specifies if a relationship is enforced or not enforced. It applies only to DB2 OS390 V8 or later versions of the platform. DATATYPE: Boolean.

 Deferrable

If true, the FK constriant check can be deferred to the end of the transaction. DATATYPE: Boolean.

 Definition

This is the definition of the relationship. DATATYPE: String.

 Disable

Applies to Oracle platforms. Determines if the FK constraint is disabled (true) or enabled (false). When set to false, the corresponding PK is also set to false. DATATYPE: Boolean.

 DoNotGenerate

If true, the Foreign Key Constraint will not be generated in the DDL of the Child Entity. DATATYPE: Boolean.

 GUID

GUID of the relationship. This GUID is assigned by ER/Studio. Each relationship has a unique GUID. DATATYPE: String.

 ID

ID of the relationship. This ID is assigned by ER/Studio. Each relationship in a diagram has a unique ID. DATATYPE: Integer.

 InitiallyDeferred

If true, the FK constriant check is Initially Deferred. DATATYPE: Boolean.

 InterModelID

InterModelID of the object. This ID is assigned by ER/Studio. DATATYPE: Integer.

 InversePhrase

This is the inverse verb phrase of the relationship. DATATYPE: String.

 LogOrPhysOnly

Controls the logical/physical only Relationship Property. DATATYPE: Boolean.

 Mandatory

This determines if the relationship is mandatory (true) or not (false). DATATYPE: Boolean.

 Name

This is the name of the relationship. DATATYPE: String.

 NOCHECK

Applies to SQL Server 2005, SQL Server 2008, Teradata v2R6, Teradata 12.0 platforms. Determines if the FK constraint is disabled (true) or enabled (false). DATATYPE: Boolean.

 Note

This the note of the relationship. DATATYPE: String.

 NotForReplication

This property specifies if a FK constraint is checked for replication. It applies only to MS SQL Server 2000 or later versions. DATATYPE: Boolean.

 NoValidate

Applies to Oracle platforms. Determines if the FK constraint is NoValidate (true) or Validate (false). DATATYPE: Boolean.

 OptionalityValue

This the Optionality of the Relationship. Optional = 0. Mandatory = 1. DATATYPE: Integer.

 ParentEntity

This is the parent entity of the relationship.

 ParentKeyID

ID of the relationship's parent index. Zero for this property indicates Primary Key. To set the relationship to use the PK, please assign zero. DATATYPE: Integer.

 Type

This is the type of the relationship. The relationship types are: Identifying - 0, NonIdentifying - 1, NonSpecific - 2, NonIdentifying Optional - 3, Containment - 8(MongoDB Only). DATATYPE: Integer.

 VerbPhrase

This is the verb phrase of the relationship. DATATYPE: String.