Class NSContactRelationEntity

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Syntax

Constructors

NSContactRelationEntity()

Initializes a new instance of the NSContactRelationEntity class.

Declaration

NSContactRelationEntity

Methods

GetActiveText()

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

String GetActiveText()

Returns

Type	Description
String	Active text for the relation.

Examples

NSContactRelationEntity thing;
String activeText = thing.GetActiveText();

GetComment()

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

String GetComment()

Returns

Type	Description
String	Comment for relation.

Examples

NSContactRelationEntity thing;
String comment = thing.GetComment();

GetCreatedBy()

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

NSAssociate GetCreatedBy()

Returns

Type	Description
NSAssociate

Examples

NSContactRelationEntity thing;
NSAssociate createdBy = thing.GetCreatedBy();

GetCreatedDate()

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

DateTime GetCreatedDate()

Returns

Type	Description
DateTime	Registered when.

Examples

NSContactRelationEntity thing;
DateTime createdDate = thing.GetCreatedDate();

GetDestinationContactId()

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

Integer GetDestinationContactId()

Returns

Type	Description
Integer	ID of the destination contact. The value is mandatory.

Examples

NSContactRelationEntity thing;
Integer destinationContactId = thing.GetDestinationContactId();

GetDestinationContactName()

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

String GetDestinationContactName()

Returns

Type	Description
String	Name of the destination contact.

Examples

NSContactRelationEntity thing;
String destinationContactName = thing.GetDestinationContactName();

GetDestinationPersonId()

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

Integer GetDestinationPersonId()

Returns

Type	Description
Integer	ID of the destination person. The value is not mandatory. The person must belong to the destination contact.

Examples

NSContactRelationEntity thing;
Integer destinationPersonId = thing.GetDestinationPersonId();

GetDestinationPersonName()

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

String GetDestinationPersonName()

Returns

Type	Description
String	Name of the destination person.

Examples

NSContactRelationEntity thing;
String destinationPersonName = thing.GetDestinationPersonName();

GetPassiveText()

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

String GetPassiveText()

Returns

Type	Description
String	Passive text for the relation.

Examples

NSContactRelationEntity thing;
String passiveText = thing.GetPassiveText();

GetRelationDefinitionId()

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

Integer GetRelationDefinitionId()

Returns

Type	Description
Integer	Reference to definition.

Examples

NSContactRelationEntity thing;
Integer relationDefinitionId = thing.GetRelationDefinitionId();

GetRelationId()

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

Integer GetRelationId()

Returns

Type	Description
Integer	Primary key.

Examples

NSContactRelationEntity thing;
Integer relationId = thing.GetRelationId();

GetReversed()

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

Integer GetReversed()

Returns

Type	Description
Integer	Is direction reversed relative to definition.

Examples

NSContactRelationEntity thing;
Integer reversed = thing.GetReversed();

GetSourceContactId()

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

Integer GetSourceContactId()

Returns

Type	Description
Integer	ID of the source contact. The value is mandatory.

Examples

NSContactRelationEntity thing;
Integer sourceContactId = thing.GetSourceContactId();

GetSourceContactName()

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

String GetSourceContactName()

Returns

Type	Description
String	Name of the source contact.

Examples

NSContactRelationEntity thing;
String sourceContactName = thing.GetSourceContactName();

GetSourcePersonId()

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

Integer GetSourcePersonId()

Returns

Type	Description
Integer	ID of the source person. The value is not mandatory. The person must belong to the source contact.

Examples

NSContactRelationEntity thing;
Integer sourcePersonId = thing.GetSourcePersonId();

GetSourcePersonName()

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

String GetSourcePersonName()

Returns

Type	Description
String	Name of the source person.

Examples

NSContactRelationEntity thing;
String sourcePersonName = thing.GetSourcePersonName();

GetUpdatedBy()

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

NSAssociate GetUpdatedBy()

Returns

Type	Description
NSAssociate

Examples

NSContactRelationEntity thing;
NSAssociate updatedBy = thing.GetUpdatedBy();

GetUpdatedDate()

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

DateTime GetUpdatedDate()

Returns

Type	Description
DateTime	Last updated when.

Examples

NSContactRelationEntity thing;
DateTime updatedDate = thing.GetUpdatedDate();

SetActiveText(String)

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

Void SetActiveText(String activeText)

Parameters

Type	Name	Description
String	activeText	Active text for the relation.

Returns

Type	Description
Void

Examples

NSContactRelationEntity thing;
String activeText;
thing.SetActiveText(activeText);

SetComment(String)

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

Void SetComment(String comment)

Parameters

Type	Name	Description
String	comment	Comment for relation.

Returns

Type	Description
Void

Examples

NSContactRelationEntity thing;
String comment;
thing.SetComment(comment);

SetCreatedBy(NSAssociate)

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

Void SetCreatedBy(NSAssociate createdBy)

Parameters

Type	Name	Description
NSAssociate	createdBy

Returns

Type	Description
Void

Examples

NSContactRelationEntity thing;
NSAssociate createdBy;
thing.SetCreatedBy(createdBy);

SetCreatedDate(DateTime)

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

Void SetCreatedDate(DateTime createdDate)

Parameters

Type	Name	Description
DateTime	createdDate	Registered when.

Returns

Type	Description
Void

Examples

NSContactRelationEntity thing;
DateTime createdDate;
thing.SetCreatedDate(createdDate);

SetDestinationContactId(Integer)

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

Void SetDestinationContactId(Integer destinationContactId)

Parameters

Type	Name	Description
Integer	destinationContactId	ID of the destination contact. The value is mandatory.

Returns

Type	Description
Void

Examples

NSContactRelationEntity thing;
Integer destinationContactId;
thing.SetDestinationContactId(destinationContactId);

SetDestinationContactName(String)

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

Void SetDestinationContactName(String destinationContactName)

Parameters

Type	Name	Description
String	destinationContactName	Name of the destination contact.

Returns

Type	Description
Void

Examples

NSContactRelationEntity thing;
String destinationContactName;
thing.SetDestinationContactName(destinationContactName);

SetDestinationPersonId(Integer)

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

Void SetDestinationPersonId(Integer destinationPersonId)

Parameters

Type	Name	Description
Integer	destinationPersonId	ID of the destination person. The value is not mandatory. The person must belong to the destination contact.

Returns

Type	Description
Void

Examples

NSContactRelationEntity thing;
Integer destinationPersonId;
thing.SetDestinationPersonId(destinationPersonId);

SetDestinationPersonName(String)

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

Void SetDestinationPersonName(String destinationPersonName)

Parameters

Type	Name	Description
String	destinationPersonName	Name of the destination person.

Returns

Type	Description
Void

Examples

NSContactRelationEntity thing;
String destinationPersonName;
thing.SetDestinationPersonName(destinationPersonName);

SetPassiveText(String)

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

Void SetPassiveText(String passiveText)

Parameters

Type	Name	Description
String	passiveText	Passive text for the relation.

Returns

Type	Description
Void

Examples

NSContactRelationEntity thing;
String passiveText;
thing.SetPassiveText(passiveText);

SetRelationDefinitionId(Integer)

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

Void SetRelationDefinitionId(Integer relationDefinitionId)

Parameters

Type	Name	Description
Integer	relationDefinitionId	Reference to definition.

Returns

Type	Description
Void

Examples

NSContactRelationEntity thing;
Integer relationDefinitionId;
thing.SetRelationDefinitionId(relationDefinitionId);

SetRelationId(Integer)

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

Void SetRelationId(Integer relationId)

Parameters

Type	Name	Description
Integer	relationId	Primary key.

Returns

Type	Description
Void

Examples

NSContactRelationEntity thing;
Integer relationId;
thing.SetRelationId(relationId);

SetReversed(Integer)

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

Void SetReversed(Integer reversed)

Parameters

Type	Name	Description
Integer	reversed	Is direction reversed relative to definition.

Returns

Type	Description
Void

Examples

NSContactRelationEntity thing;
Integer reversed;
thing.SetReversed(reversed);

SetSourceContactId(Integer)

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

Void SetSourceContactId(Integer sourceContactId)

Parameters

Type	Name	Description
Integer	sourceContactId	ID of the source contact. The value is mandatory.

Returns

Type	Description
Void

Examples

NSContactRelationEntity thing;
Integer sourceContactId;
thing.SetSourceContactId(sourceContactId);

SetSourceContactName(String)

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

Void SetSourceContactName(String sourceContactName)

Parameters

Type	Name	Description
String	sourceContactName	Name of the source contact.

Returns

Type	Description
Void

Examples

NSContactRelationEntity thing;
String sourceContactName;
thing.SetSourceContactName(sourceContactName);

SetSourcePersonId(Integer)

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

Void SetSourcePersonId(Integer sourcePersonId)

Parameters

Type	Name	Description
Integer	sourcePersonId

Returns

Type	Description
Void

Examples

NSContactRelationEntity thing;
Integer sourcePersonId;
thing.SetSourcePersonId(sourcePersonId);

SetSourcePersonName(String)

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

Void SetSourcePersonName(String sourcePersonName)

Parameters

Type	Name	Description
String	sourcePersonName	Name of the source person.

Returns

Type	Description
Void

Examples

NSContactRelationEntity thing;
String sourcePersonName;
thing.SetSourcePersonName(sourcePersonName);

SetUpdatedBy(NSAssociate)

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

Void SetUpdatedBy(NSAssociate updatedBy)

Parameters

Type	Name	Description
NSAssociate	updatedBy

Returns

Type	Description
Void

Examples

NSContactRelationEntity thing;
NSAssociate updatedBy;
thing.SetUpdatedBy(updatedBy);

SetUpdatedDate(DateTime)

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Declaration

Void SetUpdatedDate(DateTime updatedDate)

Parameters

Type	Name	Description
DateTime	updatedDate	Last updated when.

Returns

Type	Description
Void

Examples

NSContactRelationEntity thing;
DateTime updatedDate;
thing.SetUpdatedDate(updatedDate);