org.osid.tracking.rules

Interface QueueProcessorEnablerFrontOfficeAssignmentSession

All Superinterfaces:

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

public interface QueueProcessorEnablerFrontOfficeAssignmentSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	assignQueueProcessorEnablerToFrontOffice(Id queueProcessorEnablerId, Id frontOfficeId) Adds an existing QueueProcessorEnabler to an FrontFront Office.
boolean	canAssignQueueProcessorEnablers() Tests if this user can alter queue processor enabler/office mappings.
boolean	canAssignQueueProcessorEnablersToFrontOffice(Id frontOfficeId) Tests if this user can alter queue processor 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 processor enabler can be assigned.
IdList	getAssignableFrontOfficeIdsForQueueProcessorEnabler(Id frontOfficeId, Id queueProcessorEnablerId) Gets a list of front office including and under the given front office node in which a specific queue processor enabler can be assigned.
void	unassignQueueProcessorEnablerFromFrontOffice(Id queueProcessorEnablerId, Id frontOfficeId) Removes a QueueProcessorEnabler 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

canAssignQueueProcessorEnablers

boolean canAssignQueueProcessorEnablers()

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

canAssignQueueProcessorEnablersToFrontOffice

boolean canAssignQueueProcessorEnablersToFrontOffice(Id frontOfficeId)

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

getAssignableFrontOfficeIdsForQueueProcessorEnabler

IdList getAssignableFrontOfficeIdsForQueueProcessorEnabler(Id frontOfficeId,
                                                         Id queueProcessorEnablerId)
                                                           throws OperationFailedException

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

Parameters:

frontOfficeId - the Id of the FrontOffice

queueProcessorEnablerId - the Id of the QueueProcessorEnabler

Returns:

list of assignable front office Ids

Throws:

NullArgumentException - frontOfficeId or queueProcessorEnablerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignQueueProcessorEnablerToFrontOffice

void assignQueueProcessorEnablerToFrontOffice(Id queueProcessorEnablerId,
                                            Id frontOfficeId)
                                              throws AlreadyExistsException,
                                                     NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Adds an existing QueueProcessorEnabler to an FrontFront Office.

Parameters:

queueProcessorEnablerId - the Id of the QueueProcessorEnabler

frontOfficeId - the Id of the FrontOffice

Throws:

AlreadyExistsException - queueProcessorEnablerId is already assigned to frontOfficeId

NotFoundException - queueProcessorEnablerId or frontOfficeId not found

NullArgumentException - queueProcessorEnablerId or frontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignQueueProcessorEnablerFromFrontOffice

void unassignQueueProcessorEnablerFromFrontOffice(Id queueProcessorEnablerId,
                                                Id frontOfficeId)
                                                  throws NotFoundException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

Removes a QueueProcessorEnabler from an FrontFront Office.

Parameters:

queueProcessorEnablerId - the Id of the QueueProcessorEnabler

frontOfficeId - the Id of the FrontOffice

Throws:

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

NullArgumentException - queueProcessorEnablerId or frontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.