org.osid.provisioning.rules

Interface PoolConstrainerEnablerRuleLookupSession

All Superinterfaces:

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

public interface PoolConstrainerEnablerRuleLookupSession
extends OsidSession

This session provides methods to retrieve PoolConstrainerEnabler to PoolConstrainer mappings. A PoolConstrainer with multiple PoolConstrainerEnablers means any positive rule evaluation across the enablers result in an effective PoolConstrainer.

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupPoolConstrainerEnablerRules() Tests if this user can perform lookups of pool constrainer enabler/pool constrainer mappings.
Distributor	getDistributor() Gets the Distributor associated with this session.
Id	getDistributorId() Gets the Distributor Id associated with this session.
IdList	getPoolConstrainerEnablerIdsForPoolConstrainer(Id poolConstrainerId) Gets the PoolConstrainerEnabler Id associated with a PoolConstrainer.
PoolConstrainerEnablerList	getPoolConstrainerEnablersForPoolConstrainer(Id poolConstrainerId) Gets the PoolConstrainerEnablers associated with a PoolConstrainer.
IdList	getPoolConstrainerIdsForPoolConstrainerEnabler(Id poolConstrainerEnablerId) Gets the PoolConstrainer Ids mapped to a PoolConstrainerEnabler.
PoolConstrainerList	getPoolConstrainersForPoolConstrainerEnabler(Id poolConstrainerEnablerId) Gets the PoolConstrainers mapped to a PoolConstrainerEnabler.
void	useComparativePoolConstrainerEnablerRuleView() 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	usePlenaryPoolConstrainerEnablerRuleView() A complete view of the PoolConstrainerEnabler and PoolConstrainer 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.

canLookupPoolConstrainerEnablerRules

boolean canLookupPoolConstrainerEnablerRules()

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

useComparativePoolConstrainerEnablerRuleView

void useComparativePoolConstrainerEnablerRuleView()

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.

usePlenaryPoolConstrainerEnablerRuleView

void usePlenaryPoolConstrainerEnablerRuleView()

A complete view of the PoolConstrainerEnabler and PoolConstrainer 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 constrainer 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.

getPoolConstrainerEnablerIdsForPoolConstrainer

IdList getPoolConstrainerEnablerIdsForPoolConstrainer(Id poolConstrainerId)
                                                      throws NotFoundException,
                                                             OperationFailedException,
                                                             PermissionDeniedException

Gets the PoolConstrainerEnabler Id associated with a PoolConstrainer.

Parameters:

poolConstrainerId - Id of the PoolConstrainer

Returns:

the pool constrainer enabler Ids

Throws:

NotFoundException - poolConstrainerId is not found

NullArgumentException - poolConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPoolConstrainerEnablersForPoolConstrainer

PoolConstrainerEnablerList getPoolConstrainerEnablersForPoolConstrainer(Id poolConstrainerId)
                                                                        throws NotFoundException,
                                                                               OperationFailedException,
                                                                               PermissionDeniedException

Gets the PoolConstrainerEnablers associated with a PoolConstrainer.

Parameters:

poolConstrainerId - Id of the PoolConstrainer

Returns:

the pool constrainer enablers

Throws:

NotFoundException - poolConstrainerId is not found

NullArgumentException - poolConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPoolConstrainerIdsForPoolConstrainerEnabler

IdList getPoolConstrainerIdsForPoolConstrainerEnabler(Id poolConstrainerEnablerId)
                                                      throws NotFoundException,
                                                             OperationFailedException,
                                                             PermissionDeniedException

Gets the PoolConstrainer Ids mapped to a PoolConstrainerEnabler.

Parameters:

poolConstrainerEnablerId - Id of a PoolConstrainerEnabler

Returns:

list of pool constrainer Ids

Throws:

NotFoundException - poolConstrainerEnablerId is not found

NullArgumentException - poolConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPoolConstrainersForPoolConstrainerEnabler

PoolConstrainerList getPoolConstrainersForPoolConstrainerEnabler(Id poolConstrainerEnablerId)
                                                                 throws NotFoundException,
                                                                        OperationFailedException,
                                                                        PermissionDeniedException

Gets the PoolConstrainers mapped to a PoolConstrainerEnabler.

Parameters:

poolConstrainerEnablerId - Id of a PoolConstrainerEnabler

Returns:

list of pool constrainers

Throws:

NotFoundException - poolConstrainerEnablerId is not found

NullArgumentException - poolConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.