Class NumberAllocationAgent

Proxy class for the NumberAllocation Agent Used when communicating remote using WebServices. Avoid using directly. Use the AgentFactory to create the proxy instead.

Inheritance
object
NumberAllocationAgent
Inherited Members
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.Implementation.dll
Syntax
public class NumberAllocationAgent : INumberAllocationAgent, IAgent

Constructors

NumberAllocationAgent(IRefCountEntityImplementation, ISoRequestItemsAccessor)

Proxy class for the NumberAllocation Agent Used when communicating remote using WebServices. Avoid using directly. Use the AgentFactory to create the proxy instead.

Declaration
public NumberAllocationAgent(IRefCountEntityImplementation refCountEntityImplementation, ISoRequestItemsAccessor accessor)
Parameters
Type Name Description
IRefCountEntityImplementation refCountEntityImplementation
ISoRequestItemsAccessor accessor

NumberAllocationAgent(IRefCountEntityImplementation, ISoRequestItemsAccessor, IDebugUser, IServiceCallsRepository, IScriptingConfiguration, IOnlineConfiguration)

Proxy class for the NumberAllocation Agent Used when communicating remote using WebServices. Avoid using directly. Use the AgentFactory to create the proxy instead.

Declaration
public NumberAllocationAgent(IRefCountEntityImplementation refCountEntityImplementation, ISoRequestItemsAccessor accessor, IDebugUser debugUser, IServiceCallsRepository serviceCallsRepository, ConfigFile.IScriptingConfiguration scriptingConfiguration, ConfigFile.IOnlineConfiguration onlineConfiguration)
Parameters
Type Name Description
IRefCountEntityImplementation refCountEntityImplementation
ISoRequestItemsAccessor accessor
IDebugUser debugUser
IServiceCallsRepository serviceCallsRepository
IScriptingConfiguration scriptingConfiguration
IOnlineConfiguration onlineConfiguration

Methods

CreateDefaultRefCountEntityAsync(CancellationToken)

Loading default values into a new RefCountEntity.

Declaration
public Task<RefCountEntity> CreateDefaultRefCountEntityAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<RefCountEntity>

New RefCountEntity with default values

DeleteRefCountEntityAsync(int, CancellationToken)

Deletes the RefCountEntity

Declaration
public Task DeleteRefCountEntityAsync(int refCountEntityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int refCountEntityId

The identity of the RefCountEntity
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task

This method has no return value

GetNumberEachTemplateAsync(CancellationToken)

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

Declaration
public Task<bool> GetNumberEachTemplateAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<bool>

Is NumberEachTemplate?

GetRefCountEntityAsync(int, CancellationToken)

Gets a RefCountEntity object.

Declaration
public Task<RefCountEntity> GetRefCountEntityAsync(int refCountEntityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int refCountEntityId

The identifier of the RefCountEntity object
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<RefCountEntity>

A single RefCountEntity

SaveDefaultNumberingAsync(RefCountEntity, CancellationToken)

Saves default numbering values in preferences

Declaration
public Task SaveDefaultNumberingAsync(RefCountEntity refCountEntity, CancellationToken cancellationToken = default)
Parameters
Type Name Description
RefCountEntity refCountEntity

The refCountEntity that holds the values that will be saved
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task

void

SaveRefCountEntityAsync(RefCountEntity, CancellationToken)

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

Declaration
public Task<RefCountEntity> SaveRefCountEntityAsync(RefCountEntity refCountEntity, CancellationToken cancellationToken = default)
Parameters
Type Name Description
RefCountEntity refCountEntity

The RefCountEntity that is saved
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task<RefCountEntity>

New or updated RefCountEntity

SetNumberEachTemplateAsync(bool, CancellationToken)

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

Declaration
public Task SetNumberEachTemplateAsync(bool setValue, CancellationToken cancellationToken = default)
Parameters
Type Name Description
bool setValue

true or false if Automatically create new counters for new document templates
CancellationToken cancellationToken

This operation cannot be cancelled; the cancellationToken parameter is ignored
Returns
Type Description
Task

void

Implements