org.osid.tracking.rules

Interface QueueProcessorFrontOfficeSession

All Superinterfaces:

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

public interface QueueProcessorFrontOfficeSession
extends OsidSession

This session provides methods to retrieve QueueProcessor to FrontOffice mappings. a QueueProcessor may appear in multiple FrontOffice objects. Each front office may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupQueueProcessorFrontOfficeMappings() Tests if this user can perform lookups of queue processor/office mappings.
IdList	getFrontOfficeIdsByQueueProcessor(Id queueProcessorId) Gets the FrontOffice Ids mapped to a QueueProcessor.
FrontOfficeList	getFrontOfficesByQueueProcessor(Id queueProcessorId) Gets the FrontOffices mapped to a QueueProcessor.
IdList	getQueueProcessorIdsByFrontOffice(Id frontOfficeId) Gets the list of QueueProcessorIds associated with an FrontFront Office.
IdList	getQueueProcessorIdsByFrontOffices(IdList frontOfficeIds) Gets the list of QueueProcessor Ids corresponding to a list of FrontOffices.
QueueProcessorList	getQueueProcessorsByFrontOffice(Id frontOfficeId) Gets the list of queue processors associated with an FrontFront Office.
QueueProcessorList	getQueueProcessorsByFrontOffices(IdList frontOfficeIds) Gets the list of queue processor corresponding to a list of FrontOffices.
void	useComparativeQueueProcessorFrontOfficeView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryQueueProcessorFrontOfficeView() A complete view of the QueueProcessor and FrontOffice returns is desired.

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

canLookupQueueProcessorFrontOfficeMappings

boolean canLookupQueueProcessorFrontOfficeMappings()

Tests if this user can perform lookups of queue processor/office mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeQueueProcessorFrontOfficeView

void useComparativeQueueProcessorFrontOfficeView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryQueueProcessorFrontOfficeView

void usePlenaryQueueProcessorFrontOfficeView()

A complete view of the QueueProcessor and FrontOffice returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getQueueProcessorIdsByFrontOffice

IdList getQueueProcessorIdsByFrontOffice(Id frontOfficeId)
                                         throws NotFoundException,
                                                OperationFailedException,
                                                PermissionDeniedException

Gets the list of QueueProcessorIds associated with an FrontFront Office.

Parameters:

frontOfficeId - Id of the FrontOffice

Returns:

list of related queue processor Ids

Throws:

NotFoundException - frontOfficeId is not found

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getQueueProcessorsByFrontOffice

QueueProcessorList getQueueProcessorsByFrontOffice(Id frontOfficeId)
                                                   throws NotFoundException,
                                                          OperationFailedException,
                                                          PermissionDeniedException

Gets the list of queue processors associated with an FrontFront Office.

Parameters:

frontOfficeId - Id of the FrontOffice

Returns:

list of related queue processors

Throws:

NotFoundException - frontOfficeId is not found

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getQueueProcessorIdsByFrontOffices

IdList getQueueProcessorIdsByFrontOffices(IdList frontOfficeIds)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets the list of QueueProcessor Ids corresponding to a list of FrontOffices.

Parameters:

frontOfficeIds - list of front office Ids

Returns:

list of queue processor Ids

Throws:

NullArgumentException - frontOfficeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getQueueProcessorsByFrontOffices

QueueProcessorList getQueueProcessorsByFrontOffices(IdList frontOfficeIds)
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Gets the list of queue processor corresponding to a list of FrontOffices.

Parameters:

frontOfficeIds - list of front office Ids

Returns:

list of queue processors

Throws:

NullArgumentException - frontOfficeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFrontOfficeIdsByQueueProcessor

IdList getFrontOfficeIdsByQueueProcessor(Id queueProcessorId)
                                         throws NotFoundException,
                                                OperationFailedException,
                                                PermissionDeniedException

Gets the FrontOffice Ids mapped to a QueueProcessor.

Parameters:

queueProcessorId - Id of a QueueProcessor

Returns:

list of offices

Throws:

NotFoundException - queueProcessorId is not found

NullArgumentException - queueProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFrontOfficesByQueueProcessor

FrontOfficeList getFrontOfficesByQueueProcessor(Id queueProcessorId)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Gets the FrontOffices mapped to a QueueProcessor.

Parameters:

queueProcessorId - Id of a QueueProcessor

Returns:

list of offices

Throws:

NotFoundException - queueProcessorId is not found

NullArgumentException - queueProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.