Interface QueueConstrainerEnablerLookupSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface QueueConstrainerEnablerLookupSession
extends OsidSession

This session provides methods for retrieving QueueConstrainerEnablers .

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition
• isolated front office view: All queue constrainer enabler methods in this session operate, retrieve and pertain to queue constrainer enablers defined explicitly in the current front office. Using an isolated view is useful for managing QueueConstrainerEnablers with the QueueConstrainerEnablerAdminSession .
• federated front office view: All queue constrainer enabler methods in this session operate, retrieve and pertain to all queue constrainer enablers defined in this front office and any other queue constrainer enablers implicitly available in this front office through front office inheritence.
• active queue constrainer enabler view: All queue constrainer enabler lookup methods return active queue constrainer enablers.
• any active queue constrainer enabler view: Queue constrainer enablers of any active or inactive status are returned from methods.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedFrontOfficeView() and useIsolatedFrontOfficeView() behave as a radio group and one should be selected before invoking the methods in this session.

Method Summary

Modifier and Type	Method	Description
boolean	canLookupQueueConstrainerEnablers()	Tests if this user can perform QueueConstrainerEnablers lookups.
FrontOffice	getFrontOffice()	Gets the FrontOffice associated with this session.
Id	getFrontOfficeId()	Gets the FrontOffice Id associated with this session.
QueueConstrainerEnabler	getQueueConstrainerEnabler(Id queueConstrainerEnablerId)	Gets the QueueConstrainerEnabler specified by its Id .
QueueConstrainerEnablerList	getQueueConstrainerEnablers()	Gets all QueueConstrainerEnablers .
QueueConstrainerEnablerList	getQueueConstrainerEnablersByGenusType(Type queueConstrainerEnablerGenusType)	Gets a QueueConstrainerEnablerList corresponding to the given queue constrainer enabler genus Type which does not include queue constrainer enablers of genus types derived from the specified Type .
QueueConstrainerEnablerList	getQueueConstrainerEnablersByIds(IdList queueConstrainerEnablerIds)	Gets a QueueConstrainerEnablerList corresponding to the given IdList .
QueueConstrainerEnablerList	getQueueConstrainerEnablersByParentGenusType(Type queueConstrainerEnablerGenusType)	Gets a QueueConstrainerEnablerList corresponding to the given queue constrainer enabler genus Type and include any additional queue constrainer enablers with genus types derived from the specified Type .
QueueConstrainerEnablerList	getQueueConstrainerEnablersByRecordType(Type queueConstrainerEnablerRecordType)	Gets a QueueConstrainerEnablerList containing the given queue constrainer enabler record Type .
QueueConstrainerEnablerList	getQueueConstrainerEnablersOnDate(DateTime from, DateTime to)	Gets a QueueConstrainerEnablerList that are effective for the entire given date range inclusive but not confined to the date range for any agent.
QueueConstrainerEnablerList	getQueueConstrainerEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to)	Gets a QueueConstrainerEnablerList that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent.
void	useActiveQueueConstrainerEnablerView()	Only active queue constrainer enablers are returned by methods in this session.
void	useAnyStatusQueueConstrainerEnablerView()	All active and inactive queue constrainer enablers are returned by methods in this session.
void	useComparativeQueueConstrainerEnablerView()	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	useFederatedFrontOfficeView()	Federates the view for methods in this session.
void	useIsolatedFrontOfficeView()	Isolates the view for methods in this session.
void	usePlenaryQueueConstrainerEnablerView()	A complete view of the QueueConstrainerEnabler 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

getFrontOfficeId

Id getFrontOfficeId()

Gets the FrontOffice Id associated with this session.

Returns:

the FrontOffice Id associated with this session

Compliance:

mandatory - This method must be implemented.

getFrontOffice

FrontOffice getFrontOffice()
                    throws OperationFailedException,
PermissionDeniedException

Gets the FrontOffice associated with this session.

Returns:

the office

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupQueueConstrainerEnablers

boolean canLookupQueueConstrainerEnablers()

Tests if this user can perform QueueConstrainerEnablers lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeQueueConstrainerEnablerView

void useComparativeQueueConstrainerEnablerView()

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.

usePlenaryQueueConstrainerEnablerView

void usePlenaryQueueConstrainerEnablerView()

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

useFederatedFrontOfficeView

void useFederatedFrontOfficeView()

Federates the view for methods in this session. A federated view will include queue constrainer enablers in front offices which are children of this front office in the front office hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedFrontOfficeView

void useIsolatedFrontOfficeView()

Isolates the view for methods in this session. An isolated view restricts lookups to this front office only.

Compliance:

mandatory - This method is must be implemented.

useActiveQueueConstrainerEnablerView

void useActiveQueueConstrainerEnablerView()

Only active queue constrainer enablers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyStatusQueueConstrainerEnablerView

void useAnyStatusQueueConstrainerEnablerView()

All active and inactive queue constrainer enablers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

getQueueConstrainerEnabler

QueueConstrainerEnabler getQueueConstrainerEnabler(Id queueConstrainerEnablerId)
                                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the QueueConstrainerEnabler specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned QueueConstrainerEnabler may have a different Id than requested, such as the case where a duplicate Id was assigned to a QueueConstrainerEnabler and retained for compatibility. In active mode, queue constrainer enablers are returned that are currently active. In any status mode, active and inactive queue constrainer enablers are returned.

Parameters:

queueConstrainerEnablerId - Id of the QueueConstrainerEnabler

Returns:

the queue constrainer enabler

Throws:

NotFoundException - queueConstrainerEnablerId not found

NullArgumentException - queueConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getQueueConstrainerEnablersByIds

QueueConstrainerEnablerList getQueueConstrainerEnablersByIds(IdList queueConstrainerEnablerIds)
                                                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a QueueConstrainerEnablerList corresponding to the given IdList . In plenary mode, the returned list contains all of the queue constrainer enablers specified in the Id list, in the order of the list, including duplicates, or an error results if a Id in the supplied list is not found or inaccessible. Otherwise, inaccessible QueueConstrainerEnablers may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, queue constrainer enablers are returned that are currently active. In any status mode, active and inactive queue constrainer enablers are returned.

Parameters:

queueConstrainerEnablerIds - the list of Ids to retrieve

Returns:

the returned QueueConstrainerEnabler list

Throws:

NotFoundException - a Id was not found

NullArgumentException - queueConstrainerEnablerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getQueueConstrainerEnablersByGenusType

QueueConstrainerEnablerList getQueueConstrainerEnablersByGenusType(Type queueConstrainerEnablerGenusType)
                                                            throws OperationFailedException,
PermissionDeniedException

Gets a QueueConstrainerEnablerList corresponding to the given queue constrainer enabler genus Type which does not include queue constrainer enablers of genus types derived from the specified Type . In plenary mode, the returned list contains all known queue constrainer enablers or an error results. Otherwise, the returned list may contain only those queue constrainer enablers that are accessible through this session. In active mode, queue constrainer enablers are returned that are currently active. In any status mode, active and inactive queue constrainer enablers are returned.

Parameters:

queueConstrainerEnablerGenusType - a queue constrainer enabler genus type

Returns:

the returned QueueConstrainerEnabler list

Throws:

NullArgumentException - queueConstrainerEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getQueueConstrainerEnablersByParentGenusType

QueueConstrainerEnablerList getQueueConstrainerEnablersByParentGenusType(Type queueConstrainerEnablerGenusType)
                                                                  throws OperationFailedException,
PermissionDeniedException

Gets a QueueConstrainerEnablerList corresponding to the given queue constrainer enabler genus Type and include any additional queue constrainer enablers with genus types derived from the specified Type . In plenary mode, the returned list contains all known queue constrainer enablers or an error results. Otherwise, the returned list may contain only those queue constrainer enablers that are accessible through this session. In active mode, queue constrainer enablers are returned that are currently active. In any status mode, active and inactive queue constrainer enablers are returned.

Parameters:

queueConstrainerEnablerGenusType - a queue constrainer enabler genus type

Returns:

the returned QueueConstrainerEnabler list

Throws:

NullArgumentException - queueConstrainerEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getQueueConstrainerEnablersByRecordType

QueueConstrainerEnablerList getQueueConstrainerEnablersByRecordType(Type queueConstrainerEnablerRecordType)
                                                             throws OperationFailedException,
PermissionDeniedException

Gets a QueueConstrainerEnablerList containing the given queue constrainer enabler record Type . In plenary mode, the returned list contains all known queue constrainer enablers or an error results. Otherwise, the returned list may contain only those queue constrainer enablers that are accessible through this session. In active mode, queue constrainer enablers are returned that are currently active. In any status mode, active and inactive queue constrainer enablers are returned.

Parameters:

queueConstrainerEnablerRecordType - a queue constrainer enabler record type

Returns:

the returned QueueConstrainerEnabler list

Throws:

NullArgumentException - queueConstrainerEnablerRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getQueueConstrainerEnablersOnDate

QueueConstrainerEnablerList getQueueConstrainerEnablersOnDate(DateTime from,
 DateTime to)
                                                       throws OperationFailedException,
PermissionDeniedException

Gets a QueueConstrainerEnablerList that are effective for the entire given date range inclusive but not confined to the date range for any agent. In plenary mode, the returned list contains all known queue constrainer enablers or an error results. Otherwise, the returned list may contain only those queue constrainer enablers that are accessible through this session. In active mode, queue constrainer enablers are returned that are currently active. In any status mode, active and inactive queue constrainer enablers are returned.

Parameters:

from - a start date

to - an end date

Returns:

the returned QueueConstrainerEnabler list

Throws:

InvalidArgumentException - from is greater tha to

NullArgumentException - from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getQueueConstrainerEnablersOnDateWithAgent

QueueConstrainerEnablerList getQueueConstrainerEnablersOnDateWithAgent(Id agentId,
 DateTime from,
 DateTime to)
                                                                throws OperationFailedException,
PermissionDeniedException

Gets a QueueConstrainerEnablerList that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known queue constrainer enablers or an error results. Otherwise, the returned list may contain only those queue constrainer enablers that are accessible through this session. In active mode, queue constrainer enablers are returned that are currently active. In any status mode, active and inactive queue constrainer enablers are returned.

Parameters:

agentId - an agent Id

from - a start date

to - an end date

Returns:

the returned QueueConstrainerEnabler list

Throws:

InvalidArgumentException - from is greater tha to

NullArgumentException - agentId, from , or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getQueueConstrainerEnablers

QueueConstrainerEnablerList getQueueConstrainerEnablers()
                                                 throws OperationFailedException,
PermissionDeniedException

Gets all QueueConstrainerEnablers . In plenary mode, the returned list contains all known queue constrainer enablers or an error results. Otherwise, the returned list may contain only those queue constrainer enablers that are accessible through this session. In active mode, queue constrainer enablers are returned that are currently active. In any status mode, active and inactive queue constrainer enablers are returned.

Returns:

the returned QueueConstrainerEnabler list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.