org.osid.tracking.rules

Interface QueueConstrainerEnablerFrontOfficeSession

All Superinterfaces:

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

public interface QueueConstrainerEnablerFrontOfficeSession
extends OsidSession

This session provides methods to retrieve QueueConstrainerEnabler to FrontOffice mappings. a QueueConstrainerEnabler 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	canLookupQueueConstrainerEnablerFrontOfficeMappings() Tests if this user can perform lookups of queue constrainer enabler/office mappings.
IdList	getFrontOfficeIdsByQueueConstrainerEnabler(Id queueConstrainerEnablerId) Gets the FrontOffice Ids mapped to a QueueConstrainerEnabler.
FrontOfficeList	getFrontOfficesByQueueConstrainerEnabler(Id queueConstrainerEnablerId) Gets the FrontOffices mapped to a QueueConstrainerEnabler.
IdList	getQueueConstrainerEnablerIdsByFrontOffice(Id frontOfficeId) Gets the list of QueueConstrainerEnablerIds associated with an FrontFront Office.
IdList	getQueueConstrainerEnablerIdsByFrontOffices(IdList frontOfficeIds) Gets the list of QueueConstrainerEnabler Ids corresponding to a list of FrontOffices.
QueueConstrainerEnablerList	getQueueConstrainerEnablersByFrontOffice(Id frontOfficeId) Gets the list of queue constrainer enablers associated with an FrontFront Office.
QueueConstrainerEnablerList	getQueueConstrainerEnablersByFrontOffices(IdList frontOfficeIds) Gets the list of queue constrainer enablers corresponding to a list of FrontOffices.
void	useComparativeQueueConstrainerEnablerFrontOfficeView() 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	usePlenaryQueueConstrainerEnablerFrontOfficeView() A complete view of the QueueConstrainerEnabler 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

canLookupQueueConstrainerEnablerFrontOfficeMappings

boolean canLookupQueueConstrainerEnablerFrontOfficeMappings()

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

useComparativeQueueConstrainerEnablerFrontOfficeView

void useComparativeQueueConstrainerEnablerFrontOfficeView()

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.

usePlenaryQueueConstrainerEnablerFrontOfficeView

void usePlenaryQueueConstrainerEnablerFrontOfficeView()

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

getQueueConstrainerEnablerIdsByFrontOffice

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

Gets the list of QueueConstrainerEnablerIds associated with an FrontFront Office.

Parameters:

frontOfficeId - Id of the FrontOffice

Returns:

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

getQueueConstrainerEnablersByFrontOffice

QueueConstrainerEnablerList getQueueConstrainerEnablersByFrontOffice(Id frontOfficeId)
                                                                     throws NotFoundException,
                                                                            OperationFailedException,
                                                                            PermissionDeniedException

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

Parameters:

frontOfficeId - Id of the FrontOffice

Returns:

list of related queue constrainer enablers

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.

getQueueConstrainerEnablerIdsByFrontOffices

IdList getQueueConstrainerEnablerIdsByFrontOffices(IdList frontOfficeIds)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

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

Parameters:

frontOfficeIds - list of front office Ids

Returns:

list of queue constrainer enabler Ids

Throws:

NullArgumentException - frontOfficeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getQueueConstrainerEnablersByFrontOffices

QueueConstrainerEnablerList getQueueConstrainerEnablersByFrontOffices(IdList frontOfficeIds)
                                                                      throws OperationFailedException,
                                                                             PermissionDeniedException

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

Parameters:

frontOfficeIds - list of front office Ids

Returns:

list of queue constrainer enablers

Throws:

NullArgumentException - frontOfficeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFrontOfficeIdsByQueueConstrainerEnabler

IdList getFrontOfficeIdsByQueueConstrainerEnabler(Id queueConstrainerEnablerId)
                                                  throws NotFoundException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

Gets the FrontOffice Ids mapped to a QueueConstrainerEnabler.

Parameters:

queueConstrainerEnablerId - Id of a QueueConstrainerEnabler

Returns:

list of offices

Throws:

NotFoundException - queueConstrainerEnablerId is not found

NullArgumentException - queueConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFrontOfficesByQueueConstrainerEnabler

FrontOfficeList getFrontOfficesByQueueConstrainerEnabler(Id queueConstrainerEnablerId)
                                                         throws NotFoundException,
                                                                OperationFailedException,
                                                                PermissionDeniedException

Gets the FrontOffices mapped to a QueueConstrainerEnabler.

Parameters:

queueConstrainerEnablerId - Id of a QueueConstrainerEnabler

Returns:

list of offices

Throws:

NotFoundException - queueConstrainerEnablerId is not found

NullArgumentException - queueConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.