Interface QueueConstrainerEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface QueueConstrainerEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply QueueConstrainerEnablers to QueueConstrainers. Multiple QueueConstrainerEnablers applied to an QueueConstrainer may be sequenced such that the first positive evaluation results in the QueueConstrainerEnabler used.

Method Summary

Modifier and Type	Method	Description
void	assignQueueConstrainerEnablerToQueueConstrainer(Id queueConstrainerEnablerId, Id queueConstrainerId)	Adds an existing QueueConstrainerEnabler to a QueueConstrainer.
boolean	canAssignQueueConstrainerEnablers()	Tests if this user can alter queue constrainer enabler/queue constrainer mappings.
boolean	canSequenceQueueConstrainerEnablers()	Tests if this user can order QueueConstrainerEnablers.
Distributor	getDistributor()	Gets the Distributor associated with this session.
Id	getDistributorId()	Gets the Distributor Id associated with this session.
void	moveQueueConstrainerEnablerAhead(Id queueConstrainerEnablerId, Id queueConstrainerId, Id referenceId)	Reorders queue constrainer enablers for a queue constrainer by moving the specified queue constrainer enabler in front of a reference queue constrainer enabler.
void	moveQueueConstrainerEnablerBehind(Id queueConstrainerEnablerId, Id queueConstrainerId, Id referenceId)	Reorders queue constrainer enablers for a queue constrainer by moving the specified queue constrainer enabler behind a reference queue constrainer enabler.
void	orderQueueConstrainerEnablers(Id[] queueConstrainerEnablerIds, Id queueConstrainerId)	Reorders a set of queue constrainer enablers for a queue constrainer.
void	unassignQueueConstrainerEnablerFromQueueConstrainer(Id queueConstrainerEnablerId, Id queueConstrainerId)	Removes an existing QueueConstrainerEnabler from a QueueConstrainer.

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.

canAssignQueueConstrainerEnablers

boolean canAssignQueueConstrainerEnablers()

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

assignQueueConstrainerEnablerToQueueConstrainer

void assignQueueConstrainerEnablerToQueueConstrainer(Id queueConstrainerEnablerId,
 Id queueConstrainerId)
                                              throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing QueueConstrainerEnabler to a QueueConstrainer.

Parameters:

queueConstrainerEnablerId - the Id of the QueueConstrainerEnabler

queueConstrainerId - the Id of the QueueConstrainer

Throws:

AlreadyExistsException - queueConstrainerEnablerId already applied to queueConstrainerId

NotFoundException - queueConstrainerEnablerId or queueConstrainerId not found

NullArgumentException - queueConstrainerEnablerId or queueConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignQueueConstrainerEnablerFromQueueConstrainer

void unassignQueueConstrainerEnablerFromQueueConstrainer(Id queueConstrainerEnablerId,
 Id queueConstrainerId)
                                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an existing QueueConstrainerEnabler from a QueueConstrainer.

Parameters:

queueConstrainerEnablerId - the Id of the QueueConstrainerEnabler

queueConstrainerId - the Id of the QueueConstrainer

Throws:

NotFoundException - queueConstrainerEnablerId or queueConstrainerId not found or queueConstrainerEnablerId already applied to queueConstrainerId

NullArgumentException - queueConstrainerEnablerId or queueConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceQueueConstrainerEnablers

boolean canSequenceQueueConstrainerEnablers()

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

Compliance:

mandatory - This method must be implemented.

moveQueueConstrainerEnablerAhead

void moveQueueConstrainerEnablerAhead(Id queueConstrainerEnablerId,
 Id queueConstrainerId,
 Id referenceId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

queueConstrainerEnablerId - the Id of the QueueConstrainerEnabler

queueConstrainerId - the Id of the QueueConstrainer

referenceId - the reference queue constrainer enabler Id

Throws:

NotFoundException - queueConstrainerEnablerId queueConstrainerId, or referenceId not found or, queueConstrainerEnablerId or referenceId not related to queueConstrainerId

NullArgumentException - queueConstrainerEnablerId, queueConstrainerId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveQueueConstrainerEnablerBehind

void moveQueueConstrainerEnablerBehind(Id queueConstrainerEnablerId,
 Id queueConstrainerId,
 Id referenceId)
                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

queueConstrainerEnablerId - the Id of the QueueConstrainerEnabler

queueConstrainerId - the Id of the QueueConstrainer

referenceId - the reference queue constrainer Id

Throws:

NotFoundException - queueConstrainerEnablerId queueConstrainerId, or referenceId not found or, queueConstrainerEnablerId or referenceId not related to queueConstrainerId

NullArgumentException - queueConstrainerEnablerId, queueConstrainerId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderQueueConstrainerEnablers

void orderQueueConstrainerEnablers(Id[] queueConstrainerEnablerIds,
 Id queueConstrainerId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

queueConstrainerEnablerIds - the Ids for a set of QueueConstrainerEnablers

queueConstrainerId - the Id of the QueueConstrainer

Throws:

NotFoundException - queueConstrainerId not found or, a queueConstrainerEnablerId not related to queueConstrainerId

NullArgumentException - queueConstrainerEnablerIds or queueConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.