Class NSHistoryRequest

Specification for a request for history information, by ID. It is possible to ask for rights for a new record (insert), but then you need to supply the parent ID for entities that have parents (projectmember, selectionmember, person).

Constructors

NSHistoryRequest()

Initializes a new instance of the NSHistoryRequest class.

Declaration

NSHistoryRequest

Methods

GetEntityName()

Declaration

String GetEntityName()

Examples

NSHistoryRequest thing;
String entityName = thing.GetEntityName();

Returns

Type Description
String Name of entity to get history for.

GetEntityOrParentId()

Declaration

Integer GetEntityOrParentId()

Examples

NSHistoryRequest thing;
Integer entityOrParentId = thing.GetEntityOrParentId();

Returns

Type Description
Integer ID of entity to get history for, or parent entity id if requesting insert rights for an entity that has a parent.

GetRequestForNewRecord()

Declaration

Bool GetRequestForNewRecord()

Examples

NSHistoryRequest thing;
Bool requestForNewRecord = thing.GetRequestForNewRecord();

Returns

Type Description
Bool Are we requesting insert rights? If true, then EntityorParentId is taken to mean parent Id.

SetEntityName(String)

Declaration

Void SetEntityName(String entityName)

Examples

NSHistoryRequest thing;
String entityName;
thing.SetEntityName(entityName);

Parameters

Type Name Description
String entityName Name of entity to get history for.

Returns

Type Description
Void

SetEntityOrParentId(Integer)

Declaration

Void SetEntityOrParentId(Integer entityOrParentId)

Examples

NSHistoryRequest thing;
Integer entityOrParentId;
thing.SetEntityOrParentId(entityOrParentId);

Parameters

Type Name Description
Integer entityOrParentId ID of entity to get history for, or parent entity id if requesting insert rights for an entity that has a parent.

Returns

Type Description
Void

SetRequestForNewRecord(Bool)

Declaration

Void SetRequestForNewRecord(Bool requestForNewRecord)

Examples

NSHistoryRequest thing;
Bool requestForNewRecord;
thing.SetRequestForNewRecord(requestForNewRecord);

Parameters

Type Name Description
Bool requestForNewRecord Are we requesting insert rights? If true, then EntityorParentId is taken to mean parent Id.

Returns

Type Description
Void