Interface QueueFrontOfficeSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface QueueFrontOfficeSession
extends OsidSession

This session provides methods to retrieve Queue to FrontOffice mappings. A Queue 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

Modifier and Type	Method	Description
boolean	canLookupQueueFrontOfficeIssues()	Tests if this user can perform lookups of queue/front office mappings.
IdList	getFrontOfficeIdsByQueue(Id queueId)	Gets the FrontOffice Ids frontOfficeped to a Queue .
FrontOfficeList	getFrontOfficesByQueue(Id queueId)	Gets the FrontOffices frontOfficeped to a Queue .
IdList	getQueueIdsByFrontOffice(Id frontOfficeId)	Gets the list of Queue Ids associated with a FrontOffice .
IdList	getQueueIdsByFrontOffices(IdList frontOfficeIds)	Gets the list of Queue Ids corresponding to a list of FrontOffices .
QueueList	getQueuesByFrontOffice(Id frontOfficeId)	Gets the list of Queues associated with a FrontOffice .
QueueList	getQueuesByFrontOffices(IdList frontOfficeIds)	Gets the list of Queue corresponding to a list of FrontOffices .
void	useComparativeQueueFrontOfficeView()	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	usePlenaryQueueFrontOfficeView()	A complete view of the Queue and FrontOffice returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canLookupQueueFrontOfficeIssues

boolean canLookupQueueFrontOfficeIssues()

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

useComparativeQueueFrontOfficeView

void useComparativeQueueFrontOfficeView()

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.

usePlenaryQueueFrontOfficeView

void usePlenaryQueueFrontOfficeView()

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

getQueueIdsByFrontOffice

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

Gets the list of Queue Ids associated with a FrontOffice .

Parameters:

frontOfficeId - Id of the FrontOffice

Returns:

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

getQueuesByFrontOffice

QueueList getQueuesByFrontOffice(Id frontOfficeId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Queues associated with a FrontOffice .

Parameters:

frontOfficeId - Id of the FrontOffice

Returns:

list of related queues

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.

getQueueIdsByFrontOffices

IdList getQueueIdsByFrontOffices(IdList frontOfficeIds)
                          throws OperationFailedException,
PermissionDeniedException

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

Parameters:

frontOfficeIds - list of front office Ids

Returns:

list of queue Ids

Throws:

NullArgumentException - frontOfficeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getQueuesByFrontOffices

QueueList getQueuesByFrontOffices(IdList frontOfficeIds)
                           throws OperationFailedException,
PermissionDeniedException

Gets the list of Queue corresponding to a list of FrontOffices .

Parameters:

frontOfficeIds - list of front office Ids

Returns:

list of queues

Throws:

NullArgumentException - frontOfficeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFrontOfficeIdsByQueue

IdList getFrontOfficeIdsByQueue(Id queueId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the FrontOffice Ids frontOfficeped to a Queue .

Parameters:

queueId - Id of a Queue

Returns:

list of frontOffices

Throws:

NotFoundException - queueId is not found

NullArgumentException - queueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFrontOfficesByQueue

FrontOfficeList getFrontOfficesByQueue(Id queueId)
                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the FrontOffices frontOfficeped to a Queue .

Parameters:

queueId - Id of a Queue

Returns:

list of frontOffices

Throws:

NotFoundException - queueId is not found

NullArgumentException - queueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.