Interface QueueProcessorEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface QueueProcessorEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply QueueProcessorEnablers to QueueProcessors. Multiple QueueProcessorEnablers applied to an QueueProcessor may be sequenced such that the first positive evaluation results in the QueueProcessorEnabler used.

Method Summary

Modifier and Type	Method	Description
void	assignQueueProcessorEnablerToQueueProcessor(Id queueProcessorEnablerId, Id queueProcessorId)	Adds an existing QueueProcessorEnabler to a QueueProcessor.
boolean	canAssignQueueProcessorEnablers()	Tests if this user can alter queue processor enabler/queue processor mappings.
boolean	canSequenceQueueProcessorEnablers()	Tests if this user can order QueueProcessorEnablers.
Distributor	getDistributor()	Gets the Distributor associated with this session.
Id	getDistributorId()	Gets the Distributor Id associated with this session.
void	moveQueueProcessorEnablerAhead(Id queueProcessorEnablerId, Id queueProcessorId, Id referenceId)	Reorders queue processor enablers for a queue processor by moving the specified queue processor enabler in front of a reference queue processor enabler.
void	moveQueueProcessorEnablerBehind(Id queueProcessorEnablerId, Id queueProcessorId, Id referenceId)	Reorders queue processor enablers for a queue processor by moving the specified queue processor enabler behind a reference queue processor enabler.
void	orderQueueProcessorEnablers(Id[] queueProcessorEnablerIds, Id queueProcessorId)	Reorders a set of queue processor enablers for a queue processor.
void	unassignQueueProcessorEnablerFromQueueProcessor(Id queueProcessorEnablerId, Id queueProcessorId)	Removes an existing QueueProcessorEnabler from a QueueProcessor.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getDistributorId

Id getDistributorId()

Gets the Distributor Id associated with this session.

Returns:

the Distributor Id associated with this session

Compliance:

mandatory - This method must be implemented.

getDistributor

Distributor getDistributor()
                    throws OperationFailedException,
PermissionDeniedException

Gets the Distributor associated with this session.

Returns:

the distributor

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAssignQueueProcessorEnablers

boolean canAssignQueueProcessorEnablers()

Tests if this user can alter queue processor enabler/queue processor mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

assignQueueProcessorEnablerToQueueProcessor

void assignQueueProcessorEnablerToQueueProcessor(Id queueProcessorEnablerId,
 Id queueProcessorId)
                                          throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing QueueProcessorEnabler to a QueueProcessor.

Parameters:

queueProcessorEnablerId - the Id of the QueueProcessorEnabler

queueProcessorId - the Id of the QueueProcessor

Throws:

AlreadyExistsException - queueProcessorEnablerId already applied to queueProcessorId

NotFoundException - queueProcessorEnablerId or queueProcessorId not found

NullArgumentException - queueProcessorEnablerId or queueProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignQueueProcessorEnablerFromQueueProcessor

void unassignQueueProcessorEnablerFromQueueProcessor(Id queueProcessorEnablerId,
 Id queueProcessorId)
                                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an existing QueueProcessorEnabler from a QueueProcessor.

Parameters:

queueProcessorEnablerId - the Id of the QueueProcessorEnabler

queueProcessorId - the Id of the QueueProcessor

Throws:

NotFoundException - queueProcessorEnablerId or queueProcessorId not found or queueProcessorEnablerId already applied to queueProcessorId

NullArgumentException - queueProcessorEnablerId or queueProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceQueueProcessorEnablers

boolean canSequenceQueueProcessorEnablers()

Tests if this user can order QueueProcessorEnablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED.This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returns:

false if QueueProcessorEnabler ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveQueueProcessorEnablerAhead

void moveQueueProcessorEnablerAhead(Id queueProcessorEnablerId,
 Id queueProcessorId,
 Id referenceId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders queue processor enablers for a queue processor by moving the specified queue processor enabler in front of a reference queue processor enabler.

Parameters:

queueProcessorEnablerId - the Id of the QueueProcessorEnabler

queueProcessorId - the Id of the QueueProcessor

referenceId - the reference queue processor enabler Id

Throws:

NotFoundException - queueProcessorEnablerId queueProcessorId, or referenceId not found or, queueProcessorEnablerId or referenceId not related to queueProcessorId

NullArgumentException - queueProcessorEnablerId, queueProcessorId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveQueueProcessorEnablerBehind

void moveQueueProcessorEnablerBehind(Id queueProcessorEnablerId,
 Id queueProcessorId,
 Id referenceId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders queue processor enablers for a queue processor by moving the specified queue processor enabler behind a reference queue processor enabler.

Parameters:

queueProcessorEnablerId - the Id of the QueueProcessorEnabler

queueProcessorId - the Id of the QueueProcessor

referenceId - the reference queue processor Id

Throws:

NotFoundException - queueProcessorEnablerId queueProcessorId, or referenceId not found or, queueProcessorEnablerId or referenceId not related to queueProcessorId

NullArgumentException - queueProcessorEnablerId, queueProcessorId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderQueueProcessorEnablers

void orderQueueProcessorEnablers(Id[] queueProcessorEnablerIds,
 Id queueProcessorId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of queue processor enablers for a queue processor.

Parameters:

queueProcessorEnablerIds - the Ids for a set of QueueProcessorEnablers

queueProcessorId - the Id of the QueueProcessor

Throws:

NotFoundException - queueProcessorId not found or, a queueProcessorEnablerId not related to queueProcessorId

NullArgumentException - queueProcessorEnablerIds or queueProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.