org.osid.provisioning.rules

Interface PoolProcessorRuleLookupSession

All Superinterfaces:

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

public interface PoolProcessorRuleLookupSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupPoolProcessorRules() Tests if this user can perform lookups of pool processor/pool mappings.
Distributor	getDistributor() Gets the Distributor associated with this session.
Id	getDistributorId() Gets the Distributor Id associated with this session.
IdList	getPoolIdsForPoolProcessor(Id poolProcessorId) Gets the Pool Ids mapped to a PoolProcessor.
IdList	getPoolProcessorIdsForPool(Id poolId) Gets the PoolProcessor Id associated with a Pool.
PoolProcessorList	getPoolProcessorsForPool(Id poolId) Gets the PoolProcessor associated with a Pool.
PoolList	getPoolsForPoolProcessor(Id poolProcessorId) Gets the Pools mapped to a PoolProcessor.
void	useComparativePoolProcessorRuleView() 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	usePlenaryPoolProcessorRuleView() A complete view of the PoolProcessor and Pool 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.

canLookupPoolProcessorRules

boolean canLookupPoolProcessorRules()

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

useComparativePoolProcessorRuleView

void useComparativePoolProcessorRuleView()

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.

usePlenaryPoolProcessorRuleView

void usePlenaryPoolProcessorRuleView()

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

getPoolProcessorIdsForPool

IdList getPoolProcessorIdsForPool(Id poolId)
                                  throws NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Gets the PoolProcessor Id associated with a Pool.

Parameters:

poolId - Id of the Pool

Returns:

the pool processor Ids

Throws:

NotFoundException - poolId is not found

NullArgumentException - poolId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPoolProcessorsForPool

PoolProcessorList getPoolProcessorsForPool(Id poolId)
                                           throws NotFoundException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Gets the PoolProcessor associated with a Pool.

Parameters:

poolId - Id of the Pool

Returns:

the pool processors

Throws:

NotFoundException - poolId is not found

NullArgumentException - poolId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPoolIdsForPoolProcessor

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

Gets the Pool Ids mapped to a PoolProcessor.

Parameters:

poolProcessorId - Id of a PoolProcessor

Returns:

list of pool 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.

getPoolsForPoolProcessor

PoolList getPoolsForPoolProcessor(Id poolProcessorId)
                                  throws NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Gets the Pools mapped to a PoolProcessor.

Parameters:

poolProcessorId - Id of a PoolProcessor

Returns:

list of pools

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.