Interface QueueEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface QueueEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply QueueEnablers to Queues. Multiple QueueEnablers applied to an Queue may be sequenced such that the first positive evaluation results in the QueueEnablers used.

Method Summary

Modifier and Type	Method	Description
void	assignQueueEnablerToQueue(Id queueEnablerId, Id queueId)	Adds an existing QueueEnabler to a Queue.
boolean	canAssignQueueEnablers()	Tests if this user can alter queue enabler/queue mappings.
boolean	canSequenceQueueEnablers()	Tests if this user can order QueueEnablers.
Distributor	getDistributor()	Gets the Distributor associated with this session.
Id	getDistributorId()	Gets the Distributor Id associated with this session.
void	moveQueueEnablerAhead(Id queueEnablerId, Id queueId, Id referenceId)	Reorders queue enablers for a queue by moving the specified queue enabler in front of a reference queue enabler.
void	moveQueueEnablerBehind(Id queueEnablerId, Id queueId, Id referenceId)	Reorders queue enablers for a queue by moving the specified queue enabler behind a reference queue enabler.
void	orderQueueEnablers(Id[] queueEnablerIds, Id queueId)	Reorders a set of queue enablers for a queue.
void	unassignQueueEnablerFromQueue(Id queueEnablerId, Id queueId)	Removes an existing QueueEnabler from a Queue.

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.

canAssignQueueEnablers

boolean canAssignQueueEnablers()

Tests if this user can alter queue enabler/queue 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.

assignQueueEnablerToQueue

void assignQueueEnablerToQueue(Id queueEnablerId,
 Id queueId)
                        throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing QueueEnabler to a Queue.

Parameters:

queueEnablerId - the Id of the QueueEnabler

queueId - the Id of the Queue

Throws:

AlreadyExistsException - queueEnablerId already applied to queueId

NotFoundException - queueEnablerId or queueId not found

NullArgumentException - queueEnablerId or queueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignQueueEnablerFromQueue

void unassignQueueEnablerFromQueue(Id queueEnablerId,
 Id queueId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an existing QueueEnabler from a Queue.

Parameters:

queueEnablerId - the Id of the QueueEnabler

queueId - the Id of the Queue

Throws:

NotFoundException - queueEnablerId or queueId not found or queueEnablerId already applied to queueId

NullArgumentException - queueEnablerId or queueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceQueueEnablers

boolean canSequenceQueueEnablers()

Tests if this user can order QueueEnablers. 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 QueueEnabler ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveQueueEnablerAhead

void moveQueueEnablerAhead(Id queueEnablerId,
 Id queueId,
 Id referenceId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

queueEnablerId - the Id of the QueueEnabler

queueId - the Id of the Queue

referenceId - the reference queue enabler Id

Throws:

NotFoundException - queueEnablerId, queueId, or referenceId not found or, queueEnablerId or referenceId not related to queueId

NullArgumentException - queueEnablerId, queueId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveQueueEnablerBehind

void moveQueueEnablerBehind(Id queueEnablerId,
 Id queueId,
 Id referenceId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

queueEnablerId - the Id of the QueueEnabler

queueId - the Id of the Queue

referenceId - the reference queue enabler Id

Throws:

NotFoundException - queueEnablerId, queueId, or referenceId not found or, queueEnablerId or referenceId not related to queueId

NullArgumentException - queueEnablerId, queueId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderQueueEnablers

void orderQueueEnablers(Id[] queueEnablerIds,
 Id queueId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of queue enablers for a queue.

Parameters:

queueEnablerIds - the Ids for a set of QueueEnablers

queueId - the Id of the Queue

Throws:

NotFoundException - queueEnablerId, queueId, or referenceId not found or, queueEnablerId or referenceId not related to queueId

NullArgumentException - queueEnablerIds, queueId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.