Class NSForeignKey

Carrier object for ForeignKey.

Syntax

Constructors

NSForeignKey()

Initializes a new instance of the NSForeignKey class.

Declaration

NSForeignKey

Methods

GetCreatedBy()

Carrier object for ForeignKey.

Declaration

String GetCreatedBy()

Returns

Type	Description
String	Name of the person that created the foreign key.

Examples

NSForeignKey thing;
String createdBy = thing.GetCreatedBy();

GetCreatedDate()

Carrier object for ForeignKey.

Declaration

DateTime GetCreatedDate()

Returns

Type	Description
DateTime	Registered when.

Examples

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

GetKey()

Carrier object for ForeignKey.

Declaration

String GetKey()

Returns

Type	Description
String	Subkey (optional).

Examples

NSForeignKey thing;
String key = thing.GetKey();

GetRecordId()

Carrier object for ForeignKey.

Declaration

Integer GetRecordId()

Returns

Type	Description
Integer	Record in the referenced table.

Examples

NSForeignKey thing;
Integer recordId = thing.GetRecordId();

GetTableName()

Carrier object for ForeignKey.

Declaration

String GetTableName()

Returns

Type	Description
String

Examples

NSForeignKey thing;
String tableName = thing.GetTableName();

GetUpdatedBy()

Name of the person that last updated the foreign key

Declaration

String GetUpdatedBy()

Returns

Type	Description
String	Table name, transformed to and from numeric table id by the service layer.

Examples

NSForeignKey thing;
String updatedBy = thing.GetUpdatedBy();

GetUpdatedDate()

Carrier object for ForeignKey.

Declaration

DateTime GetUpdatedDate()

Returns

Type	Description
DateTime	Last updated when.

Examples

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

GetValue()

Carrier object for ForeignKey.

Declaration

String GetValue()

Returns

Type	Description
String	Key value.

Examples

NSForeignKey thing;
String value = thing.GetValue();

SetCreatedBy(String)

Carrier object for ForeignKey.

Declaration

Void SetCreatedBy(String createdBy)

Parameters

Type	Name	Description
String	createdBy	Name of the person that created the foreign key.

Returns

Type	Description
Void

Examples

NSForeignKey thing;
String createdBy;
thing.SetCreatedBy(createdBy);

SetCreatedDate(DateTime)

Carrier object for ForeignKey.

Declaration

Void SetCreatedDate(DateTime createdDate)

Parameters

Type	Name	Description
DateTime	createdDate	Registered when.

Returns

Type	Description
Void

Examples

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

SetKey(String)

Carrier object for ForeignKey.

Declaration

Void SetKey(String key)

Parameters

Type	Name	Description
String	key	Subkey (optional).

Returns

Type	Description
Void

Examples

NSForeignKey thing;
String key;
thing.SetKey(key);

SetRecordId(Integer)

Carrier object for ForeignKey.

Declaration

Void SetRecordId(Integer recordId)

Parameters

Type	Name	Description
Integer	recordId	Record in the referenced table.

Returns

Type	Description
Void

Examples

NSForeignKey thing;
Integer recordId;
thing.SetRecordId(recordId);

SetTableName(String)

Carrier object for ForeignKey.

Declaration

Void SetTableName(String tableName)

Parameters

Type	Name	Description
String	tableName	Table name, transformed to and from numeric table id by the service layer.

Returns

Type	Description
Void

Examples

NSForeignKey thing;
String tableName;
thing.SetTableName(tableName);

SetUpdatedBy(String)

Carrier object for ForeignKey.

Declaration

Void SetUpdatedBy(String updatedBy)

Parameters

Type	Name	Description
String	updatedBy	Name of the person that last updated the foreign key.

Returns

Type	Description
Void

Examples

NSForeignKey thing;
String updatedBy;
thing.SetUpdatedBy(updatedBy);

SetUpdatedDate(DateTime)

Carrier object for ForeignKey.

Declaration

Void SetUpdatedDate(DateTime updatedDate)

Parameters

Type	Name	Description
DateTime	updatedDate	Last updated when.

Returns

Type	Description
Void

Examples

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

SetValue(String)

Carrier object for ForeignKey.

Declaration

Void SetValue(String value)

Parameters

Type	Name	Description
String	value	Key value.

Returns

Type	Description
Void

Examples

NSForeignKey thing;
String value;
thing.SetValue(value);