Skip to main content

Interface INumberAllocationAgent

Namespace: SuperOffice.WebApi.Agents
Assembly: SuperOffice.WebApi.dll
This agent can be used to manage number allocation

Implements

IAgentBase, IDisposable

Methods

CreateDefaultRefCountEntityAsync(RequestOptions)

Set default values into a new RefCountEntity. NetServer calculates default values on the entity, which is required when creating/storing a new instance

Parameters

requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<RefCountEntity&gt; A blank RefCountEntity

DeleteRefCountEntityAsync(int, RequestOptions)

Deletes the RefCountEntity

Parameters

refCountEntityId int The identity of the RefCountEntity requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task

GetNumberEachTemplateAsync(RequestOptions)

Returns true or false if Automatically create new counters for new document templates

Parameters

requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<bool&gt; Is NumberEachTemplate?

GetRefCountEntityAsync(int, RequestOptions)

Gets a specific RefCountEntity object.

Parameters

refCountEntityId int The identifier of the RefCountEntity object requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<RefCountEntity&gt; RefCountEntity

SaveDefaultNumberingAsync(RefCountEntity, RequestOptions)

Saves default numbering values in preferences

Parameters

refCountEntity RefCountEntity The refCountEntity that holds the values that will be saved requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task void

SaveRefCountEntityAsync(RefCountEntity, RequestOptions)

Updates the existing RefCountEntity or creates a new RefCountEntity if the id parameter is 0.

Parameters

refCountEntity RefCountEntity The RefCountEntity that is saved. requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<RefCountEntity&gt; New or updated RefCountEntity

SetNumberEachTemplateAsync(bool, RequestOptions)

Saves true or false if Automatically create new counters for new document templates

Parameters

setValue bool true or false if Automatically create new counters for new document templates requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task void