org.osid.provisioning.rules

Interface BrokerConstrainerEnablerRuleLookupSession

All Superinterfaces:

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

public interface BrokerConstrainerEnablerRuleLookupSession
extends OsidSession

This session provides methods to retrieve BrokerConstrainerEnabler to BrokerConstrainer mappings. A BrokerConstrainer with multiple BrokerConstrainerEnablers means any positive rule evaluation across the enablers result in an effective BrokerConstrainer.

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupBrokerConstrainerEnablerRules() Tests if this user can perform lookups of broker constrainer enabler/broker constrainer mappings.
IdList	getBrokerConstrainerEnablerIdsForBrokerConstrainer(Id brokerConstrainerId) Gets the BrokerConstrainerEnabler Id associated with a BrokerConstrainer.
BrokerConstrainerEnablerList	getBrokerConstrainerEnablersForBrokerConstrainer(Id brokerConstrainerId) Gets the BrokerConstrainerEnablers associated with a BrokerConstrainer.
IdList	getBrokerConstrainerIdsForBrokerConstrainerEnabler(Id brokerConstrainerEnablerId) Gets the BrokerConstrainer Ids mapped to a BrokerConstrainerEnabler.
BrokerConstrainerList	getBrokerConstrainersForBrokerConstrainerEnabler(Id brokerConstrainerEnablerId) Gets the BrokerConstrainers mapped to a BrokerConstrainerEnabler.
Distributor	getDistributor() Gets the Distributor associated with this session.
Id	getDistributorId() Gets the Distributor Id associated with this session.
void	useComparativeBrokerConstrainerEnablerRuleView() 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	usePlenaryBrokerConstrainerEnablerRuleView() A complete view of the BrokerConstrainerEnabler and BrokerConstrainer 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.

canLookupBrokerConstrainerEnablerRules

boolean canLookupBrokerConstrainerEnablerRules()

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

useComparativeBrokerConstrainerEnablerRuleView

void useComparativeBrokerConstrainerEnablerRuleView()

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.

usePlenaryBrokerConstrainerEnablerRuleView

void usePlenaryBrokerConstrainerEnablerRuleView()

A complete view of the BrokerConstrainerEnabler and BrokerConstrainer 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 broker 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.

getBrokerConstrainerEnablerIdsForBrokerConstrainer

IdList getBrokerConstrainerEnablerIdsForBrokerConstrainer(Id brokerConstrainerId)
                                                          throws NotFoundException,
                                                                 OperationFailedException,
                                                                 PermissionDeniedException

Gets the BrokerConstrainerEnabler Id associated with a BrokerConstrainer.

Parameters:

brokerConstrainerId - Id of the BrokerConstrainer

Returns:

the broker constrainer enabler Ids

Throws:

NotFoundException - brokerConstrainerId is not found

NullArgumentException - brokerConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBrokerConstrainerEnablersForBrokerConstrainer

BrokerConstrainerEnablerList getBrokerConstrainerEnablersForBrokerConstrainer(Id brokerConstrainerId)
                                                                              throws NotFoundException,
                                                                                     OperationFailedException,
                                                                                     PermissionDeniedException

Gets the BrokerConstrainerEnablers associated with a BrokerConstrainer.

Parameters:

brokerConstrainerId - Id of the BrokerConstrainer

Returns:

the broker constrainer enablers

Throws:

NotFoundException - brokerConstrainerId is not found

NullArgumentException - brokerConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBrokerConstrainerIdsForBrokerConstrainerEnabler

IdList getBrokerConstrainerIdsForBrokerConstrainerEnabler(Id brokerConstrainerEnablerId)
                                                          throws NotFoundException,
                                                                 OperationFailedException,
                                                                 PermissionDeniedException

Gets the BrokerConstrainer Ids mapped to a BrokerConstrainerEnabler.

Parameters:

brokerConstrainerEnablerId - Id of a BrokerConstrainerEnabler

Returns:

list of broker constrainer Ids

Throws:

NotFoundException - brokerConstrainerEnablerId is not found

NullArgumentException - brokerConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBrokerConstrainersForBrokerConstrainerEnabler

BrokerConstrainerList getBrokerConstrainersForBrokerConstrainerEnabler(Id brokerConstrainerEnablerId)
                                                                       throws NotFoundException,
                                                                              OperationFailedException,
                                                                              PermissionDeniedException

Gets the BrokerConstrainers mapped to a BrokerConstrainerEnabler.

Parameters:

brokerConstrainerEnablerId - Id of a BrokerConstrainerEnabler

Returns:

list of broker constrainers

Throws:

NotFoundException - brokerConstrainerEnablerId is not found

NullArgumentException - brokerConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.