org.osid.tracking.rules

Interface QueueConstrainerFrontOfficeSession

All Superinterfaces:

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

public interface QueueConstrainerFrontOfficeSession
extends OsidSession

This session provides methods to retrieve QueueConstrainer to FrontOffice mappings. a QueueConstrainer 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	canLookupQueueConstrainerFrontOfficeMappings() Tests if this user can perform lookups of queue constrainer/office mappings.
IdList	getFrontOfficeIdsByQueueConstrainer(Id queueConstrainerId) Gets the FrontOffice Ids mapped to a QueueConstrainer.
FrontOfficeList	getFrontOfficesByQueueConstrainer(Id queueConstrainerId) Gets the FrontOffices mapped to a QueueConstrainer.
IdList	getQueueConstrainerIdsByFrontOffice(Id frontOfficeId) Gets the list of QueueConstrainerIds associated with an FrontFront Office.
IdList	getQueueConstrainerIdsByFrontOffices(IdList frontOfficeIds) Gets the list of QueueConstrainer Ids corresponding to a list of FrontOffices.
QueueConstrainerList	getQueueConstrainersByFrontOffice(Id frontOfficeId) Gets the list of queue constrainer associated with an FrontFront Office.
QueueConstrainerList	getQueueConstrainersByFrontOffices(IdList frontOfficeIds) Gets the list of queue constrainer corresponding to a list of FrontOffices.
void	useComparativeQueueConstrainerFrontOfficeView() 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	usePlenaryQueueConstrainerFrontOfficeView() A complete view of the QueueConstrainer 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

canLookupQueueConstrainerFrontOfficeMappings

boolean canLookupQueueConstrainerFrontOfficeMappings()

Tests if this user can perform lookups of queue constrainer/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.

useComparativeQueueConstrainerFrontOfficeView

void useComparativeQueueConstrainerFrontOfficeView()

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.

usePlenaryQueueConstrainerFrontOfficeView

void usePlenaryQueueConstrainerFrontOfficeView()

A complete view of the QueueConstrainer 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.

getQueueConstrainerIdsByFrontOffice

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

Gets the list of QueueConstrainerIds associated with an FrontFront Office.

Parameters:

frontOfficeId - Id of the FrontOffice

Returns:

list of related queue constrainer 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.

getQueueConstrainersByFrontOffice

QueueConstrainerList getQueueConstrainersByFrontOffice(Id frontOfficeId)
                                                       throws NotFoundException,
                                                              OperationFailedException,
                                                              PermissionDeniedException

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

Parameters:

frontOfficeId - Id of the FrontOffice

Returns:

list of related queue constrainers

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.

getQueueConstrainerIdsByFrontOffices

IdList getQueueConstrainerIdsByFrontOffices(IdList frontOfficeIds)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

frontOfficeIds - list of front office Ids

Returns:

list of queue constrainer Ids

Throws:

NullArgumentException - frontOfficeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getQueueConstrainersByFrontOffices

QueueConstrainerList getQueueConstrainersByFrontOffices(IdList frontOfficeIds)
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

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

Parameters:

frontOfficeIds - list of front office Ids

Returns:

list of queue constrainers

Throws:

NullArgumentException - frontOfficeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFrontOfficeIdsByQueueConstrainer

IdList getFrontOfficeIdsByQueueConstrainer(Id queueConstrainerId)
                                           throws NotFoundException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Gets the FrontOffice Ids mapped to a QueueConstrainer.

Parameters:

queueConstrainerId - Id of a QueueConstrainer

Returns:

list of offices

Throws:

NotFoundException - queueConstrainerId is not found

NullArgumentException - queueConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFrontOfficesByQueueConstrainer

FrontOfficeList getFrontOfficesByQueueConstrainer(Id queueConstrainerId)
                                                  throws NotFoundException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

Gets the FrontOffices mapped to a QueueConstrainer.

Parameters:

queueConstrainerId - Id of a QueueConstrainer

Returns:

list of offices

Throws:

NotFoundException - queueConstrainerId is not found

NullArgumentException - queueConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.