org.osid.provisioning.rules

Interface QueueProcessorEnablerRuleLookupSession

All Superinterfaces:

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

public interface QueueProcessorEnablerRuleLookupSession
extends OsidSession

This session provides methods to retrieve QueueProcessorEnabler to QueueProcessor mappings. a QueueProcessor with multiple QueueProcessorEnablers means any positive rule evaluation across the enablers result in an effective QueueProcessor.

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupQueueProcessorEnablerRules() Tests if this user can perform lookups of queue processor enabler/queue processor mappings.
Distributor	getDistributor() Gets the Distributor associated with this session.
Id	getDistributorId() Gets the Distributor Id associated with this session.
IdList	getQueueProcessorEnablerIdsForQueueProcessor(Id queueProcessorId) Gets the QueueProcessorEnabler Id associated with a QueueProcessor.
QueueProcessorEnablerList	getQueueProcessorEnablersForQueueProcessor(Id queueProcessorId) Gets the QueueProcessorEnabler associated with a QueueProcessor.
IdList	getQueueProcessorIdsForQueueProcessorEnabler(Id queueProcessorEnablerId) Gets the QueueProcessor Ids mapped to a QueueProcessorEnabler.
QueueProcessorList	getQueueProcessorsForQueueProcessorEnabler(Id queueProcessorEnablerId) Gets the QueueProcessors mapped to a QueueProcessorEnabler.
void	useComparativeQueueProcessorEnablerRuleView() 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	useFederatedDistributorView() Federates the view for methods in this session.
void	useIsolatedDistributorView() Isolates the view for methods in this session.
void	usePlenaryQueueProcessorEnablerRuleView() A complete view of the QueueProcessorEnabler and QueueProcessor 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

getDistributorId

Id getDistributorId()

Gets the Distributor Id associated with this session.

Returns:

the Distributor Id associated with this session

Compliance:

mandatory - This method must be implemented.

getDistributor

Distributor getDistributor()
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets the Distributor associated with this session.

Returns:

the distributor

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupQueueProcessorEnablerRules

boolean canLookupQueueProcessorEnablerRules()

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

useComparativeQueueProcessorEnablerRuleView

void useComparativeQueueProcessorEnablerRuleView()

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.

usePlenaryQueueProcessorEnablerRuleView

void usePlenaryQueueProcessorEnablerRuleView()

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

useFederatedDistributorView

void useFederatedDistributorView()

Federates the view for methods in this session. A federated view will include queue processor enablers in distributors which are children of this distributor in the distributor hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedDistributorView

void useIsolatedDistributorView()

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

Compliance:

mandatory - This method is must be implemented.

getQueueProcessorEnablerIdsForQueueProcessor

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

Gets the QueueProcessorEnabler Id associated with a QueueProcessor.

Parameters:

queueProcessorId - Id of the QueueProcessor

Returns:

the queue processor enabler 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.

getQueueProcessorEnablersForQueueProcessor

QueueProcessorEnablerList getQueueProcessorEnablersForQueueProcessor(Id queueProcessorId)
                                                                     throws NotFoundException,
                                                                            OperationFailedException,
                                                                            PermissionDeniedException

Gets the QueueProcessorEnabler associated with a QueueProcessor.

Parameters:

queueProcessorId - Id of the QueueProcessor

Returns:

the queue processor enablers

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.

getQueueProcessorIdsForQueueProcessorEnabler

IdList getQueueProcessorIdsForQueueProcessorEnabler(Id queueProcessorEnablerId)
                                                    throws NotFoundException,
                                                           OperationFailedException,
                                                           PermissionDeniedException

Gets the QueueProcessor Ids mapped to a QueueProcessorEnabler.

Parameters:

queueProcessorEnablerId - Id of a QueueProcessorEnabler

Returns:

list of queue processor Ids

Throws:

NotFoundException - queueProcessorEnablerId is not found

NullArgumentException - queueProcessorEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getQueueProcessorsForQueueProcessorEnabler

QueueProcessorList getQueueProcessorsForQueueProcessorEnabler(Id queueProcessorEnablerId)
                                                              throws NotFoundException,
                                                                     OperationFailedException,
                                                                     PermissionDeniedException

Gets the QueueProcessors mapped to a QueueProcessorEnabler.

Parameters:

queueProcessorEnablerId - Id of a QueueProcessorEnabler

Returns:

list of queue processors

Throws:

NotFoundException - queueProcessorEnablerId is not found

NullArgumentException - queueProcessorEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.