Class NSContactRelationEntity

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

Constructors

NSContactRelationEntity()

Initializes a new instance of the NSContactRelationEntity class.

Declaration

NSContactRelationEntity

Methods

GetActiveText()

Declaration

String GetActiveText()

Examples

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

Returns

Type Description
String Active text for the relation.

GetComment()

Declaration

String GetComment()

Examples

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

Returns

Type Description
String Comment for relation.

GetCreatedBy()

Declaration

NSAssociate GetCreatedBy()

Examples

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

Returns

Type Description
NSAssociate

GetCreatedDate()

Declaration

DateTime GetCreatedDate()

Examples

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

Returns

Type Description
DateTime Registered when.

GetDestinationContactId()

Declaration

Integer GetDestinationContactId()

Examples

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

Returns

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

GetDestinationContactName()

Declaration

String GetDestinationContactName()

Examples

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

Returns

Type Description
String Name of the destination contact.

GetDestinationPersonId()

Declaration

Integer GetDestinationPersonId()

Examples

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

Returns

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

GetDestinationPersonName()

Declaration

String GetDestinationPersonName()

Examples

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

Returns

Type Description
String Name of the destination person.

GetPassiveText()

Declaration

String GetPassiveText()

Examples

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

Returns

Type Description
String Passive text for the relation.

GetRelationDefinitionId()

Declaration

Integer GetRelationDefinitionId()

Examples

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

Returns

Type Description
Integer Reference to definition.

GetRelationId()

Declaration

Integer GetRelationId()

Examples

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

Returns

Type Description
Integer Primary key.

GetReversed()

Declaration

Integer GetReversed()

Examples

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

Returns

Type Description
Integer Is direction reversed relative to definition.

GetSourceContactId()

Declaration

Integer GetSourceContactId()

Examples

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

Returns

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

GetSourceContactName()

Declaration

String GetSourceContactName()

Examples

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

Returns

Type Description
String Name of the source contact.

GetSourcePersonId()

Declaration

Integer GetSourcePersonId()

Examples

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

Returns

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

GetSourcePersonName()

Declaration

String GetSourcePersonName()

Examples

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

Returns

Type Description
String Name of the source person.

GetUpdatedBy()

Declaration

NSAssociate GetUpdatedBy()

Examples

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

Returns

Type Description
NSAssociate

GetUpdatedDate()

Declaration

DateTime GetUpdatedDate()

Examples

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

Returns

Type Description
DateTime Last updated when.

SetActiveText(String)

Declaration

Void SetActiveText(String activeText)

Examples

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

Parameters

Type Name Description
String activeText Active text for the relation.

Returns

Type Description
Void

SetComment(String)

Declaration

Void SetComment(String comment)

Examples

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

Parameters

Type Name Description
String comment Comment for relation.

Returns

Type Description
Void

SetCreatedBy(NSAssociate)

Declaration

Void SetCreatedBy(NSAssociate createdBy)

Examples

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

Parameters

Type Name Description
NSAssociate createdBy

Returns

Type Description
Void

SetCreatedDate(DateTime)

Declaration

Void SetCreatedDate(DateTime createdDate)

Examples

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

Parameters

Type Name Description
DateTime createdDate Registered when.

Returns

Type Description
Void

SetDestinationContactId(Integer)

Declaration

Void SetDestinationContactId(Integer destinationContactId)

Examples

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

Parameters

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

Returns

Type Description
Void

SetDestinationContactName(String)

Declaration

Void SetDestinationContactName(String destinationContactName)

Examples

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

Parameters

Type Name Description
String destinationContactName Name of the destination contact.

Returns

Type Description
Void

SetDestinationPersonId(Integer)

Declaration

Void SetDestinationPersonId(Integer destinationPersonId)

Examples

NSContactRelationEntity thing;
Integer destinationPersonId;
thing.SetDestinationPersonId(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

SetDestinationPersonName(String)

Declaration

Void SetDestinationPersonName(String destinationPersonName)

Examples

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

Parameters

Type Name Description
String destinationPersonName Name of the destination person.

Returns

Type Description
Void

SetPassiveText(String)

Declaration

Void SetPassiveText(String passiveText)

Examples

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

Parameters

Type Name Description
String passiveText Passive text for the relation.

Returns

Type Description
Void

SetRelationDefinitionId(Integer)

Declaration

Void SetRelationDefinitionId(Integer relationDefinitionId)

Examples

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

Parameters

Type Name Description
Integer relationDefinitionId Reference to definition.

Returns

Type Description
Void

SetRelationId(Integer)

Declaration

Void SetRelationId(Integer relationId)

Examples

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

Parameters

Type Name Description
Integer relationId Primary key.

Returns

Type Description
Void

SetReversed(Integer)

Declaration

Void SetReversed(Integer reversed)

Examples

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

Parameters

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

Returns

Type Description
Void

SetSourceContactId(Integer)

Declaration

Void SetSourceContactId(Integer sourceContactId)

Examples

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

Parameters

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

Returns

Type Description
Void

SetSourceContactName(String)

Declaration

Void SetSourceContactName(String sourceContactName)

Examples

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

Parameters

Type Name Description
String sourceContactName Name of the source contact.

Returns

Type Description
Void

SetSourcePersonId(Integer)

Declaration

Void SetSourcePersonId(Integer sourcePersonId)

Examples

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

Parameters

Type Name Description
Integer sourcePersonId

Returns

Type Description
Void

SetSourcePersonName(String)

Declaration

Void SetSourcePersonName(String sourcePersonName)

Examples

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

Parameters

Type Name Description
String sourcePersonName Name of the source person.

Returns

Type Description
Void

SetUpdatedBy(NSAssociate)

Declaration

Void SetUpdatedBy(NSAssociate updatedBy)

Examples

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

Parameters

Type Name Description
NSAssociate updatedBy

Returns

Type Description
Void

SetUpdatedDate(DateTime)

Declaration

Void SetUpdatedDate(DateTime updatedDate)

Examples

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

Parameters

Type Name Description
DateTime updatedDate Last updated when.

Returns

Type Description
Void