Class NSForeignKey

Carrier object for ForeignKey.

Constructors

NSForeignKey()

Initializes a new instance of the NSForeignKey class.

Declaration

NSForeignKey

Methods

GetCreatedBy()

Declaration

String GetCreatedBy()

Examples

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

Returns

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

GetCreatedDate()

Declaration

DateTime GetCreatedDate()

Examples

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

Returns

Type	Description
DateTime	Registered when.

GetKey()

Declaration

String GetKey()

Examples

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

Returns

Type	Description
String	Subkey (optional).

GetRecordId()

Declaration

Integer GetRecordId()

Examples

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

Returns

Type	Description
Integer	Record in the referenced table.

GetTableName()

Declaration

String GetTableName()

Examples

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

Returns

Type	Description
String

GetUpdatedBy()

Name of the person that last updated the foreign key

Declaration

String GetUpdatedBy()

Examples

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

Returns

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

GetUpdatedDate()

Declaration

DateTime GetUpdatedDate()

Examples

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

Returns

Type	Description
DateTime	Last updated when.

GetValue()

Declaration

String GetValue()

Examples

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

Returns

Type	Description
String	Key value.

SetCreatedBy(String)

Declaration

Void SetCreatedBy(String createdBy)

Examples

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

Parameters

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

Returns

Type	Description
Void

SetCreatedDate(DateTime)

Declaration

Void SetCreatedDate(DateTime createdDate)

Examples

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

Parameters

Type	Name	Description
DateTime	createdDate	Registered when.

Returns

Type	Description
Void

SetKey(String)

Declaration

Void SetKey(String key)

Examples

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

Parameters

Type	Name	Description
String	key	Subkey (optional).

Returns

Type	Description
Void

SetRecordId(Integer)

Declaration

Void SetRecordId(Integer recordId)

Examples

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

Parameters

Type	Name	Description
Integer	recordId	Record in the referenced table.

Returns

Type	Description
Void

SetTableName(String)

Declaration

Void SetTableName(String tableName)

Examples

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

Parameters

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

Returns

Type	Description
Void

SetUpdatedBy(String)

Declaration

Void SetUpdatedBy(String updatedBy)

Examples

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

Parameters

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

Returns

Type	Description
Void

SetUpdatedDate(DateTime)

Declaration

Void SetUpdatedDate(DateTime updatedDate)

Examples

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

Parameters

Type	Name	Description
DateTime	updatedDate	Last updated when.

Returns

Type	Description
Void

SetValue(String)

Declaration

Void SetValue(String value)

Examples

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

Parameters

Type	Name	Description
String	value	Key value.

Returns

Type	Description
Void