Interface QueueProcessorEnablerLookupSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface QueueProcessorEnablerLookupSession
extends OsidSession

This session provides methods for retrieving QueueProcessorEnablers .

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 processor enabler methods in this session operate, retrieve and pertain to queue processor enablers defined explicitly in the current front office. Using an isolated view is useful for managing QueueProcessorEnablers with the QueueProcessorEnablerAdminSession .
• federated front office view: All queue processor enabler methods in this session operate, retrieve and pertain to all queue processor enablers defined in this front office and any other queue processor enablers implicitly available in this front office through front office inheritence.
• actuve queue processor enabler view: All queue processor enabler lookup methods return active queue processor enablers.
• any stayus queue processor enabler view: Queue processor 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	canLookupQueueProcessorEnablers()	Tests if this user can perform QueueProcessorEnablers lookups.
FrontOffice	getFrontOffice()	Gets the FrontOffice associated with this session.
Id	getFrontOfficeId()	Gets the FrontOffice Id associated with this session.
QueueProcessorEnabler	getQueueProcessorEnabler(Id queueProcessorEnablerId)	Gets the QueueProcessorEnabler specified by its Id .
QueueProcessorEnablerList	getQueueProcessorEnablers()	Gets all QueueProcessorEnablers .
QueueProcessorEnablerList	getQueueProcessorEnablersByGenusType(Type queueProcessorEnablerGenusType)	Gets a QueueProcessorEnablerList corresponding to the given queue processor enabler genus Type which does not include queue processor enablers of genus types derived from the specified Type .
QueueProcessorEnablerList	getQueueProcessorEnablersByIds(IdList queueProcessorEnablerIds)	Gets a QueueProcessorEnablerList corresponding to the given IdList .
QueueProcessorEnablerList	getQueueProcessorEnablersByParentGenusType(Type queueProcessorEnablerGenusType)	Gets a QueueProcessorEnablerList corresponding to the given queue processor enabler genus Type and include any additional queue processor enablers with genus types derived from the specified Type .
QueueProcessorEnablerList	getQueueProcessorEnablersByRecordType(Type queueProcessorEnablerRecordType)	Gets a QueueProcessorEnablerList containing the given queue processor enabler record Type .
QueueProcessorEnablerList	getQueueProcessorEnablersOnDate(DateTime from, DateTime to)	Gets a QueueProcessorEnablerList that are effective for the entire given date range inclusive but not confined to the date range for any agent.
QueueProcessorEnablerList	getQueueProcessorEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to)	Gets a QueueProcessorEnablerList that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent.
void	useActiveQueueProcessorEnablerView()	Only active queue processor enablers are returned by methods in this session.
void	useAnyStatusQueueProcessorEnablerView()	All active and inactive queue processor enablers are returned by methods in this session.
void	useComparativeQueueProcessorEnablerView()	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	usePlenaryQueueProcessorEnablerView()	A complete view of the QueueProcessorEnabler 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.

canLookupQueueProcessorEnablers

boolean canLookupQueueProcessorEnablers()

Tests if this user can perform QueueProcessorEnablers 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.

useComparativeQueueProcessorEnablerView

void useComparativeQueueProcessorEnablerView()

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.

usePlenaryQueueProcessorEnablerView

void usePlenaryQueueProcessorEnablerView()

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

useActiveQueueProcessorEnablerView

void useActiveQueueProcessorEnablerView()

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

Compliance:

mandatory - This method is must be implemented.

useAnyStatusQueueProcessorEnablerView

void useAnyStatusQueueProcessorEnablerView()

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

Compliance:

mandatory - This method is must be implemented.

getQueueProcessorEnabler

QueueProcessorEnabler getQueueProcessorEnabler(Id queueProcessorEnablerId)
                                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

queueProcessorEnablerId - Id of the QueueProcessorEnabler

Returns:

the queue processor enabler

Throws:

NotFoundException - queueProcessorEnablerId not found

NullArgumentException - queueProcessorEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getQueueProcessorEnablersByIds

QueueProcessorEnablerList getQueueProcessorEnablersByIds(IdList queueProcessorEnablerIds)
                                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a QueueProcessorEnablerList corresponding to the given IdList . In plenary mode, the returned list contains all of the queue processor 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 QueueProcessorEnablers may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, queue processor enablers are returned that are currently active. In any status mode, active and inactive queue processors enablers are returned.

Parameters:

queueProcessorEnablerIds - the list of Ids to retrieve

Returns:

the returned QueueProcessorEnabler list

Throws:

NotFoundException - a Id was not found

NullArgumentException - queueProcessorEnablerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getQueueProcessorEnablersByGenusType

QueueProcessorEnablerList getQueueProcessorEnablersByGenusType(Type queueProcessorEnablerGenusType)
                                                        throws OperationFailedException,
PermissionDeniedException

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

Parameters:

queueProcessorEnablerGenusType - a queue processor enabler genus type

Returns:

the returned QueueProcessorEnabler list

Throws:

NullArgumentException - queueProcessorEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getQueueProcessorEnablersByParentGenusType

QueueProcessorEnablerList getQueueProcessorEnablersByParentGenusType(Type queueProcessorEnablerGenusType)
                                                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

queueProcessorEnablerGenusType - a queue processor enabler genus type

Returns:

the returned QueueProcessorEnabler list

Throws:

NullArgumentException - queueProcessorEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getQueueProcessorEnablersByRecordType

QueueProcessorEnablerList getQueueProcessorEnablersByRecordType(Type queueProcessorEnablerRecordType)
                                                         throws OperationFailedException,
PermissionDeniedException

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

Parameters:

queueProcessorEnablerRecordType - a queue processor enabler record type

Returns:

the returned QueueProcessorEnabler list

Throws:

NullArgumentException - queueProcessorEnablerRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getQueueProcessorEnablersOnDate

QueueProcessorEnablerList getQueueProcessorEnablersOnDate(DateTime from,
 DateTime to)
                                                   throws OperationFailedException,
PermissionDeniedException

Gets a QueueProcessorEnablerList 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 processor enablers or an error results. Otherwise, the returned list may contain only those queue processor enablers that are accessible through this session. In active mode, queue processor enablers are returned that are currently active. In any status mode, active and inactive queue processors enablers are returned.

Parameters:

from - a start date

to - an end date

Returns:

the returned QueueProcessorEnabler 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.

getQueueProcessorEnablersOnDateWithAgent

QueueProcessorEnablerList getQueueProcessorEnablersOnDateWithAgent(Id agentId,
 DateTime from,
 DateTime to)
                                                            throws OperationFailedException,
PermissionDeniedException

Gets a QueueProcessorEnablerList 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 processor enablers or an error results. Otherwise, the returned list may contain only those queue processor enablers that are accessible through this session. In active mode, queue processor enablers are returned that are currently active. In any status mode, active and inactive queue processors enablers are returned.

Parameters:

agentId - an agent Id

from - a start date

to - an end date

Returns:

the returned QueueProcessorEnabler 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.

getQueueProcessorEnablers

QueueProcessorEnablerList getQueueProcessorEnablers()
                                             throws OperationFailedException,
PermissionDeniedException

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

Returns:

the returned QueueProcessorEnabler list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.