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).
Syntax
Constructors
NSHistoryRequest()
Initializes a new instance of the NSHistoryRequest class.
Declaration
NSHistoryRequest
Methods
GetEntityName()
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).
Declaration
String GetEntityName()
Returns
Type | Description |
---|---|
String | Name of entity to get history for. |
Examples
NSHistoryRequest thing;
String entityName = thing.GetEntityName();
GetEntityOrParentId()
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).
Declaration
Integer 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. |
Examples
NSHistoryRequest thing;
Integer entityOrParentId = thing.GetEntityOrParentId();
GetRequestForNewRecord()
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).
Declaration
Bool GetRequestForNewRecord()
Returns
Type | Description |
---|---|
Bool | Are we requesting insert rights? If true, then EntityorParentId is taken to mean parent Id. |
Examples
NSHistoryRequest thing;
Bool requestForNewRecord = thing.GetRequestForNewRecord();
SetEntityName(String)
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).
Declaration
Void SetEntityName(String entityName)
Parameters
Type | Name | Description |
---|---|---|
String | entityName | Name of entity to get history for. |
Returns
Type | Description |
---|---|
Void |
Examples
NSHistoryRequest thing;
String entityName;
thing.SetEntityName(entityName);
SetEntityOrParentId(Integer)
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).
Declaration
Void SetEntityOrParentId(Integer 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 |
Examples
NSHistoryRequest thing;
Integer entityOrParentId;
thing.SetEntityOrParentId(entityOrParentId);
SetRequestForNewRecord(Bool)
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).
Declaration
Void SetRequestForNewRecord(Bool 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 |
Examples
NSHistoryRequest thing;
Bool requestForNewRecord;
thing.SetRequestForNewRecord(requestForNewRecord);