Class NSNumberAllocationAgent
This agent can be used to manage number allocation.
Syntax
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()Returns
| Type | Description |
|---|---|
| NSRefCountEntity |
Remarks
NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance
Examples
NSNumberAllocationAgent agent;
NSRefCountEntity thing = agent.CreateDefaultRefCountEntity();
thing = agent.SaveRefCountEntity(thing);DeleteRefCountEntity(Integer)
Deletes the NSRefCountEntity
Declaration
DeleteRefCountEntity(Integer refCountEntity)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | refCountEntity | The identity of the RefCountEntity to delete. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSNumberAllocationAgent agent;
agent.DeleteRefCountEntity(123);GetNumberEachTemplate()
Returns true or false if Automatically create new counters for new document templates
Declaration
Bool GetNumberEachTemplate()Returns
| Type | Description |
|---|---|
| Bool |
Examples
NSNumberAllocationAgent agent;
Bool res = agent.GetNumberEachTemplate();GetRefCountEntity(Integer)
Gets an NSRefCountEntity object.
Declaration
NSRefCountEntity GetRefCountEntity(Integer refCountEntityId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | refCountEntityId | The identifier of the NSRefCountEntity object. |
Returns
| Type | Description |
|---|---|
| NSRefCountEntity |
Examples
NSNumberAllocationAgent agent;
NSRefCountEntity thing = agent.GetRefCountEntity(123);SaveDefaultNumbering(NSRefCountEntity)
Saves default numbering values in preferences
Declaration
Void SaveDefaultNumbering(NSRefCountEntity refCountEntity)Parameters
| Type | Name | Description |
|---|---|---|
| NSRefCountEntity | refCountEntity | The entity that holds the values that will be saved. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSNumberAllocationAgent agent;
NSRefCountEntity refCountEntity;
agent.SaveDefaultNumbering(NSRefCountEntity);SaveRefCountEntity(NSRefCountEntity)
Updates the existing NSRefCountEntity or creates a new NSRefCountEntity if the id parameter is 0
Declaration
NSRefCountEntity SaveRefCountEntity(NSRefCountEntity refCountEntity)Parameters
| Type | Name | Description |
|---|---|---|
| NSRefCountEntity | refCountEntity | The NSRefCountEntity to save. |
Returns
| Type | Description |
|---|---|
| NSRefCountEntity |
Examples
NSNumberAllocation agent;
NSRefCountEntity thing = agent.CreateDefaultRefCountEntity();
thing = agent.SaveRefCountEntity(thing);SetNumberEachTemplate(Bool)
Saves true or false if Automatically create new counters for new document templates
Declaration
Void SetNumberEachTemplate(Bool setValue)Parameters
| Type | Name | Description |
|---|---|---|
| Bool | setValue |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSNumberAllocationAgent agent;
Bool setValue;
agent.SetNumberEachTemplate(setValue);