Public Methods

MethodDescription

 BoundAttachments

Get all the BoundAttachments of this Relationship.

 ChildAction

Returns the child action of the given type. Valid action types are: INSERT, UPDATE, and DELETE. The return action names are: NONE, RESTRICT, CASCADE, SETNULL, and SETDEFAULT. PARAMETERS: ActionType (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. Valid action types are: INSERT, UPDATE, and DELETE. The return action names are: NONE, RESTRICT, CASCADE, SETNULL, and SETDEFAULT. PARAMETERS: ActionType (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. Valid action types are: INSERT, UPDATE, or DELETE. The action names are: NONE, RESTRICT, CASCADE, SETNULL, and SETDEFAULT. PARAMETERS: ActionType and ActionName (Strings).

 SetParentAction

Sets the parent action of the given type with the given action. Valid action types are: INSERT, UPDATE, and DELETE. The action names are: NONE, RESTRICT, CASCADE, SETNULL, and SETDEFAULT. PARAMETERS: ActionType and ActionName (Strings).

 UserComments

Returns a collection of user comments associated with this Relationship.

Public Properties

MethodDescription

 BusinessName

Business name of the relationship. DATATYPE: String.

 CardinalityNo

Child Cardinality Number of the relationship. Valid values are: 0 = Zero or One to Zero or More, 1 = Zero or One to One or More, 2 = Zero or One to Zero or One, 3 = Zero or One to exactly N. DATATYPE: Integer.

 CardinalityValue

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

 ChildEntity

Child entity of the relationship.

 DB2OSNotEnforced

DB2 OS390 V8 and later only. Specifies whether a relationship is enforced. DATATYPE: Boolean.

 Deferrable

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

 Definition

Definition of the relationship. DATATYPE: String.

 Disable

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

 DoNotGenerate

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

 GUID

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

 ID

ID of the relationship as 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 as assigned by ER/Studio. DATATYPE: Integer.

 InversePhrase

Inverse verb phrase of the relationship. DATATYPE: String.

 LogOrPhysOnly

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

 Mandatory

Determines whether the relationship is mandatory (true). DATATYPE: Boolean.

 Name

Name of the relationship. DATATYPE: String.

 NOCHECK

Microsoft SQL Server 2005 and 2008, Teradata v2R6 and 12.0 only. Determines if the FK constraint is disabled (true). DATATYPE: Boolean.

 Note

Note of the relationship. DATATYPE: String.

 NotForReplication

Microsoft SQL Server 2000 and later only. Specifies whether an FK constraint is checked for replication. DATATYPE: Boolean.

 NoValidate

Oracle only. Determines whether the FK constraint is NoValidate (true) or Validate (false). DATATYPE: Boolean.

 OptionalityValue

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

 ParentEntity

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, assign zero. DATATYPE: Integer.

 Type

Type of the relationship. Valid relationship types are: 0 = Identifying, 1 = NonIdentifying, 2 = NonSpecific, 3 = NonIdentifying Optional, 8 = Containment (MongoDB only). DATATYPE: Integer.

 VerbPhrase

Verb phrase of the relationship. DATATYPE: String.

  • No labels