Class NSNumberAllocationAgent
This agent can be used to manage number allocation.
Examples
NSNumberAllocationAgent agent;
agent.callMethod(arg1, arg2);Constructors
NSNumberAllocationAgent()
This agent can be used to manage number allocation.
Declaration
NSNumberAllocationAgentExamples
NSNumberAllocationAgent agent;
agent.callMethod(arg1, arg2);Methods
CreateDefaultRefCountEntity()
Sets default values into a new NSRefCountEntity.
Declaration
NSRefCountEntity CreateDefaultRefCountEntity()Examples
NSNumberAllocationAgent agent;
NSRefCountEntity thing = agent.CreateDefaultRefCountEntity();
thing = agent.SaveRefCountEntity(thing);Returns
| Type | Description |
| NSRefCountEntity |
DeleteRefCountEntity(Integer)
Deletes the NSRefCountEntity
Declaration
DeleteRefCountEntity(Integer refCountEntity)Examples
NSNumberAllocationAgent agent;
agent.DeleteRefCountEntity(123);Parameters
| Type | Name | Description |
| Integer | refCountEntity | The identity of the RefCountEntity to delete. |
Returns
| Type | Description |
| Void |
GetNumberEachTemplate()
Returns true or false if Automatically create new counters for new document templates
Declaration
Bool GetNumberEachTemplate()Examples
NSNumberAllocationAgent agent;
Bool res = agent.GetNumberEachTemplate();Returns
| Type | Description |
| Bool |
GetRefCountEntity(Integer)
Gets an NSRefCountEntity object.
Declaration
NSRefCountEntity GetRefCountEntity(Integer refCountEntityId)Examples
NSNumberAllocationAgent agent;
NSRefCountEntity thing = agent.GetRefCountEntity(123);Parameters
| Type | Name | Description |
| Integer | refCountEntityId | The identifier of the NSRefCountEntity object. |
Returns
| Type | Description |
| NSRefCountEntity |
SaveDefaultNumbering(NSRefCountEntity)
Saves default numbering values in preferences
Declaration
Void SaveDefaultNumbering(NSRefCountEntity refCountEntity)Examples
NSNumberAllocationAgent agent;
NSRefCountEntity refCountEntity;
agent.SaveDefaultNumbering(NSRefCountEntity);Parameters
| Type | Name | Description |
| NSRefCountEntity | refCountEntity | The entity that holds the values that will be saved. |
Returns
| Type | Description |
| Void |
SaveRefCountEntity(NSRefCountEntity)
Updates the existing NSRefCountEntity or creates a new NSRefCountEntity if the id parameter is 0
Declaration
NSRefCountEntity SaveRefCountEntity(NSRefCountEntity refCountEntity)Examples
NSNumberAllocation agent;
NSRefCountEntity thing = agent.CreateDefaultRefCountEntity();
thing = agent.SaveRefCountEntity(thing);Parameters
| Type | Name | Description |
| NSRefCountEntity | refCountEntity | The NSRefCountEntity to save. |
Returns
| Type | Description |
| NSRefCountEntity |
SetNumberEachTemplate(Bool)
Saves true or false if Automatically create new counters for new document templates
Declaration
Void SetNumberEachTemplate(Bool setValue)Examples
NSNumberAllocationAgent agent;
Bool setValue;
agent.SetNumberEachTemplate(setValue);Parameters
| Type | Name | Description |
| Bool | setValue |
Returns
| Type | Description |
| Void |