org.osid.tracking.rules

Interface QueueProcessorRuleLookupSession

All Superinterfaces:

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

public interface QueueProcessorRuleLookupSession
extends OsidSession

This session provides methods to retrieve QueueProcessor to Queue mappings.

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
• isolated front office view: All methods in this session operate, retrieve and pertain queue processor defined explicitly in the current front office
• federated front office view: All methods in this session operate, retrieve and pertain to all queue processor defined in this front office and any other queue processor implicitly available in this front office through front office inheritence.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupQueueProcessorRules() Tests if this user can perform lookups of queue processor/queue mappings.
FrontOffice	getFrontOffice() Gets the FrontOffice associated with this session.
Id	getFrontOfficeId() Gets the FrontOffice Id associated with this session.
IdList	getQueueIdsForQueueProcessor(Id queueProcessorId) Gets the Queue Ids mapped to a QueueProcessor.
IdList	getQueueProcessorIdsForQueue(Id queueId) Gets the QueueProcessor Id associated with a Queue.
QueueProcessorList	getQueueProcessorsForQueue(Id queueId) Gets the QueueProcessor associated with a Queue.
QueueList	getQueuesForQueueProcessor(Id queueProcessorId) Gets the Queues mapped to a QueueProcessor.
void	useComparativeQueueProcessorRuleView() 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	usePlenaryQueueProcessorRuleView() A complete view of the QueueProcessor and Queue 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

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.

canLookupQueueProcessorRules

boolean canLookupQueueProcessorRules()

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

useComparativeQueueProcessorRuleView

void useComparativeQueueProcessorRuleView()

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.

usePlenaryQueueProcessorRuleView

void usePlenaryQueueProcessorRuleView()

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

getQueueProcessorIdsForQueue

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

Gets the QueueProcessor Id associated with a Queue.

Parameters:

queueId - Id of the Queue

Returns:

the queue processor Ids

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.

getQueueProcessorsForQueue

QueueProcessorList getQueueProcessorsForQueue(Id queueId)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Gets the QueueProcessor associated with a Queue.

Parameters:

queueId - Id of the Auction

Returns:

the queue processors

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.

getQueueIdsForQueueProcessor

IdList getQueueIdsForQueueProcessor(Id queueProcessorId)
                                    throws NotFoundException,
                                           OperationFailedException,
                                           PermissionDeniedException

Gets the Queue Ids mapped to a QueueProcessor.

Parameters:

queueProcessorId - Id of a QueueProcessor

Returns:

list of queue Ids

Throws:

NotFoundException - queueProcessorId is not found

NullArgumentException - queueProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getQueuesForQueueProcessor

QueueList getQueuesForQueueProcessor(Id queueProcessorId)
                                     throws NotFoundException,
                                            OperationFailedException,
                                            PermissionDeniedException

Gets the Queues mapped to a QueueProcessor.

Parameters:

queueProcessorId - Id of a QueueProcessor

Returns:

list of queues

Throws:

NotFoundException - queueProcessorId is not found

NullArgumentException - queueProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.