org.osid.tracking

Interface QueueFrontOfficeAssignmentSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface QueueFrontOfficeAssignmentSession
extends OsidSession

This session provides methods to re-assign Queues to FrontOffice objects. A Queue may appear in multiple FrontOffice objects and removing the last reference to a Queue 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 Queue to another FrontOffice is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignQueueToFrontOffice(Id queueId, Id frontOfficeId) Adds an existing Queue to a FrontOffice.
boolean	canAssignQueues() Tests if this user can alter queue/front office mappings.
boolean	canAssignQueuesToFrontOffice(Id frontOfficeId) Tests if this user can alter queue/front office mappings.
IdList	getAssignableFrontOfficeIds(Id frontOfficeId) Gets a list of front offices including and under the given front office node in which any queue can be assigned.
IdList	getAssignableFrontOfficeIdsForQueue(Id frontOfficeId, Id queueId) Gets a list of front offices including and under the given front office node in which a specific queue can be assigned.
void	unassignQueueFromFrontOffice(Id queueId, Id frontOfficeId) Removes a Queue from a FrontOffice.

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canAssignQueues

boolean canAssignQueues()

Tests if this user can alter queue/front office mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known issue 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 assignment operations to unauthorized users.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignQueuesToFrontOffice

boolean canAssignQueuesToFrontOffice(Id frontOfficeId)

Tests if this user can alter queue/front office mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known issue 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 assignment 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 offices including and under the given front office node in which any queue 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.

getAssignableFrontOfficeIdsForQueue

IdList getAssignableFrontOfficeIdsForQueue(Id frontOfficeId,
                                         Id queueId)
                                           throws OperationFailedException

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

Parameters:

frontOfficeId - the Id of the FrontOffice

queueId - the Id of the Queue

Returns:

list of assignable front office Ids

Throws:

NullArgumentException - frontOfficeId or queueId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignQueueToFrontOffice

void assignQueueToFrontOffice(Id queueId,
                            Id frontOfficeId)
                              throws AlreadyExistsException,
                                     NotFoundException,
                                     OperationFailedException,
                                     PermissionDeniedException

Adds an existing Queue to a FrontOffice.

Parameters:

queueId - the Id of the Queue

frontOfficeId - the Id of the FrontOffice

Throws:

AlreadyExistsException - queueId is already assigned to frontOfficeId

NotFoundException - queueId or frontOfficeId not found

NullArgumentException - queueId or frontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignQueueFromFrontOffice

void unassignQueueFromFrontOffice(Id queueId,
                                Id frontOfficeId)
                                  throws NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Removes a Queue from a FrontOffice.

Parameters:

queueId - the Id of the Queue

frontOfficeId - the Id of the FrontOffice

Throws:

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

NullArgumentException - queueId or frontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.