Interface QueueConstrainerEnablerFrontOfficeAssignmentSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface QueueConstrainerEnablerFrontOfficeAssignmentSession
extends OsidSession

This session provides methods to re-assign QueueConstrainerEnabler to FrontOffice mappings. a QueueConstrainerEnabler may appear in multiple FrontOffice objects and removing the last reference to a QueueConstrainerEnabler is the equivalent of deleting it. Each FrontOffice may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a QueueConstrainerEnabler to another FrontOffice is not a copy operation (eg: does not change its Id ).

Method Summary

Modifier and Type	Method	Description
void	assignQueueConstrainerEnablerToFrontOffice(Id queueConstrainerEnablerId, Id frontOfficeId)	Adds an existing QueueConstrainerEnabler to a FrontFront Office .
boolean	canAssignQueueConstrainerEnablers()	Tests if this user can alter queue constrainer enabler/office mappings.
boolean	canAssignQueueConstrainerEnablersToFrontOffice(Id frontOfficeId)	Tests if this user can alter queue constrainer enabler/office mappings.
IdList	getAssignableFrontOfficeIds(Id frontOfficeId)	Gets a list of front office including and under the given front office node in which any queue constrainer enabler can be assigned.
IdList	getAssignableFrontOfficeIdsForQueueConstrainerEnabler(Id frontOfficeId, Id queueConstrainerEnablerId)	Gets a list of front office including and under the given front office node in which a specific queue constrainer enabler can be assigned.
void	reassignQueueConstrainerEnablerToFrontOffice(Id queueConstrainerEnablerId, Id fromFrontOfficeId, Id toFrontOfficeId)	Moves a QueueConstrainerEnabler from one FrontOffice to another.
void	unassignQueueConstrainerEnablerFromFrontOffice(Id queueConstrainerEnablerId, Id frontOfficeId)	Removes a QueueConstrainerEnabler from a FrontFront Office .

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

canAssignQueueConstrainerEnablers

boolean canAssignQueueConstrainerEnablers()

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

canAssignQueueConstrainerEnablersToFrontOffice

boolean canAssignQueueConstrainerEnablersToFrontOffice(Id frontOfficeId)

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

Parameters:

frontOfficeId - the Id of the FrontOffice

Returns:

false if mapping is not authorized, true otherwise

Throws:

NullArgumentException - frontOfficeId is null

Compliance:

mandatory - This method must be implemented.

getAssignableFrontOfficeIds

IdList getAssignableFrontOfficeIds(Id frontOfficeId)
                            throws OperationFailedException

Gets a list of front office including and under the given front office node in which any queue constrainer enabler can be assigned.

Parameters:

frontOfficeId - the Id of the FrontOffice

Returns:

list of assignable front office Ids

Throws:

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignableFrontOfficeIdsForQueueConstrainerEnabler

IdList getAssignableFrontOfficeIdsForQueueConstrainerEnabler(Id frontOfficeId,
 Id queueConstrainerEnablerId)
                                                      throws OperationFailedException

Gets a list of front office including and under the given front office node in which a specific queue constrainer enabler can be assigned.

Parameters:

frontOfficeId - the Id of the FrontOffice

queueConstrainerEnablerId - the Id of the QueueConstrainerEnabler

Returns:

list of assignable front office Ids

Throws:

NullArgumentException - frontOfficeId or queueConstrainerEnablerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignQueueConstrainerEnablerToFrontOffice

void assignQueueConstrainerEnablerToFrontOffice(Id queueConstrainerEnablerId,
 Id frontOfficeId)
                                         throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing QueueConstrainerEnabler to a FrontFront Office .

Parameters:

queueConstrainerEnablerId - the Id of the QueueConstrainerEnabler

frontOfficeId - the Id of the FrontOffice

Throws:

AlreadyExistsException - queueConstrainerEnablerId is already assigned to frontOfficeId

NotFoundException - queueConstrainerEnablerId or frontOfficeId not found

NullArgumentException - queueConstrainerEnablerId or frontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignQueueConstrainerEnablerFromFrontOffice

void unassignQueueConstrainerEnablerFromFrontOffice(Id queueConstrainerEnablerId,
 Id frontOfficeId)
                                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a QueueConstrainerEnabler from a FrontFront Office .

Parameters:

queueConstrainerEnablerId - the Id of the QueueConstrainerEnabler

frontOfficeId - the Id of the FrontOffice

Throws:

NotFoundException - queueConstrainerEnablerId or frontOfficeId not found or queueConstrainerEnablerId not assigned to frontOfficeId

NullArgumentException - queueConstrainerEnablerId or frontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignQueueConstrainerEnablerToFrontOffice

void reassignQueueConstrainerEnablerToFrontOffice(Id queueConstrainerEnablerId,
 Id fromFrontOfficeId,
 Id toFrontOfficeId)
                                           throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Moves a QueueConstrainerEnabler from one FrontOffice to another. Mappings to other FrontOffices are unaffected.

Parameters:

queueConstrainerEnablerId - the Id of the QueueConstrainerEnabler

fromFrontOfficeId - the Id of the current FrontOffice

toFrontOfficeId - the Id of the destination FrontOffice

Throws:

AlreadyExistsException - queueConstrainerEnablerId already assigned to toFrontOfficeId

NotFoundException - queueConstrainerEnablerId, fromFrontOfficeId , or toFrontOfficeId not found or queueConstrainerEnablerId not mapped to fromFrontOfficeId

NullArgumentException - queueConstrainerEnablerId, fromFrontOfficeId , or toFrontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.