org.osid.provisioning.rules

Interface PoolProcessorEnablerRuleLookupSession

All Superinterfaces:

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

public interface PoolProcessorEnablerRuleLookupSession
extends OsidSession

This session provides methods to retrieve PoolProcessorEnabler to PoolProcessor mappings. A PoolProcessor with multiple PoolProcessorEnablers means any positive rule evaluation across the enablers result in an effective PoolProcessor.

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupPoolProcessorEnablerRules() Tests if this user can perform lookups of pool processor enabler/pool processor mappings.
Distributor	getDistributor() Gets the Distributor associated with this session.
Id	getDistributorId() Gets the Distributor Id associated with this session.
IdList	getPoolProcessorEnablerIdsForPoolProcessor(Id poolProcessorId) Gets the PoolProcessorEnabler Id associated with a PoolProcessor.
PoolProcessorEnablerList	getPoolProcessorEnablersForPoolProcessor(Id poolProcessorId) Gets the PoolProcessorEnabler associated with a PoolProcessor.
IdList	getPoolProcessorIdsForPoolProcessorEnabler(Id poolProcessorEnablerId) Gets the PoolProcessor Ids mapped to a PoolProcessorEnabler.
PoolProcessorList	getPoolProcessorsForPoolProcessorEnabler(Id poolProcessorEnablerId) Gets the PoolProcessors mapped to a PoolProcessorEnabler.
void	useComparativePoolProcessorEnablerRuleView() 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	usePlenaryPoolProcessorEnablerRuleView() A complete view of the PoolProcessorEnabler and PoolProcessor 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.

canLookupPoolProcessorEnablerRules

boolean canLookupPoolProcessorEnablerRules()

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

useComparativePoolProcessorEnablerRuleView

void useComparativePoolProcessorEnablerRuleView()

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.

usePlenaryPoolProcessorEnablerRuleView

void usePlenaryPoolProcessorEnablerRuleView()

A complete view of the PoolProcessorEnabler and PoolProcessor 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 pool 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.

getPoolProcessorEnablerIdsForPoolProcessor

IdList getPoolProcessorEnablerIdsForPoolProcessor(Id poolProcessorId)
                                                  throws NotFoundException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

Gets the PoolProcessorEnabler Id associated with a PoolProcessor.

Parameters:

poolProcessorId - Id of the PoolProcessor

Returns:

the pool processor enabler Ids

Throws:

NotFoundException - poolProcessorId is not found

NullArgumentException - poolProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPoolProcessorEnablersForPoolProcessor

PoolProcessorEnablerList getPoolProcessorEnablersForPoolProcessor(Id poolProcessorId)
                                                                  throws NotFoundException,
                                                                         OperationFailedException,
                                                                         PermissionDeniedException

Gets the PoolProcessorEnabler associated with a PoolProcessor.

Parameters:

poolProcessorId - Id of the PoolProcessor

Returns:

the pool processor enablers

Throws:

NotFoundException - poolProcessorId is not found

NullArgumentException - poolProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPoolProcessorIdsForPoolProcessorEnabler

IdList getPoolProcessorIdsForPoolProcessorEnabler(Id poolProcessorEnablerId)
                                                  throws NotFoundException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

Gets the PoolProcessor Ids mapped to a PoolProcessorEnabler.

Parameters:

poolProcessorEnablerId - Id of a PoolProcessorEnabler

Returns:

list of pool processor Ids

Throws:

NotFoundException - poolProcessorEnablerId is not found

NullArgumentException - poolProcessorEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPoolProcessorsForPoolProcessorEnabler

PoolProcessorList getPoolProcessorsForPoolProcessorEnabler(Id poolProcessorEnablerId)
                                                           throws NotFoundException,
                                                                  OperationFailedException,
                                                                  PermissionDeniedException

Gets the PoolProcessors mapped to a PoolProcessorEnabler.

Parameters:

poolProcessorEnablerId - Id of a PoolProcessorEnabler

Returns:

list of pool processors

Throws:

NotFoundException - poolProcessorEnablerId is not found

NullArgumentException - poolProcessorEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.