org.osid.tracking.rules

Interface QueueProcessorFrontOfficeAssignmentSession

All Superinterfaces:

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

public interface QueueProcessorFrontOfficeAssignmentSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	assignQueueProcessorToFrontOffice(Id queueProcessorId, Id frontOfficeId) Adds an existing QueueProcessor to an FrontFront Office.
boolean	canAssignQueueProcessors() Tests if this user can alter queue processor/office mappings.
boolean	canAssignQueueProcessorsToFrontOffice(Id frontOfficeId) Tests if this user can alter queue processor/office mappings.
IdList	getAssignableFrontOfficeIds(Id frontOfficeId) Gets a list of front office including and under the given front office node in which any queue processor can be assigned.
IdList	getAssignableFrontOfficeIdsForQueueProcessor(Id frontOfficeId, Id queueProcessorId) Gets a list of front office including and under the given front office node in which a specific queue processor can be assigned.
void	unassignQueueProcessorFromFrontOffice(Id queueProcessorId, Id frontOfficeId) Removes a QueueProcessor from an FrontFront Office.

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

canAssignQueueProcessors

boolean canAssignQueueProcessors()

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

canAssignQueueProcessorsToFrontOffice

boolean canAssignQueueProcessorsToFrontOffice(Id frontOfficeId)

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

getAssignableFrontOfficeIdsForQueueProcessor

IdList getAssignableFrontOfficeIdsForQueueProcessor(Id frontOfficeId,
                                                  Id queueProcessorId)
                                                    throws OperationFailedException

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

Parameters:

frontOfficeId - the Id of the FrontOffice

queueProcessorId - the Id of the QueueProcessor

Returns:

list of assignable front office Ids

Throws:

NullArgumentException - frontOfficeId or queueProcessorId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignQueueProcessorToFrontOffice

void assignQueueProcessorToFrontOffice(Id queueProcessorId,
                                     Id frontOfficeId)
                                       throws AlreadyExistsException,
                                              NotFoundException,
                                              OperationFailedException,
                                              PermissionDeniedException

Adds an existing QueueProcessor to an FrontFront Office.

Parameters:

queueProcessorId - the Id of the QueueProcessor

frontOfficeId - the Id of the FrontOffice

Throws:

AlreadyExistsException - queueProcessorId is already assigned to frontOfficeId

NotFoundException - queueProcessorId or frontOfficeId not found

NullArgumentException - queueProcessorId or frontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignQueueProcessorFromFrontOffice

void unassignQueueProcessorFromFrontOffice(Id queueProcessorId,
                                         Id frontOfficeId)
                                           throws NotFoundException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Removes a QueueProcessor from an FrontFront Office.

Parameters:

queueProcessorId - the Id of the QueueProcessor

frontOfficeId - the Id of the FrontOffice

Throws:

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

NullArgumentException - queueProcessorId or frontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.