org.osid.provisioning.rules

Interface BrokerConstrainerRuleLookupSession

All Superinterfaces:

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

public interface BrokerConstrainerRuleLookupSession
extends OsidSession

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

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupBrokerConstrainerRules() Tests if this user can perform lookups of broker constrainer/broker mappings.
IdList	getBrokerConstrainerIdsForBroker(Id distributorId) Gets the BrokerConstrainer Id associated with a Broker.
BrokerConstrainerList	getBrokerConstrainersForBroker(Id distributorId) Gets the BrokerConstrainer associated with a Broker.
IdList	getBrokerIdsForBrokerConstrainer(Id brokerConstrainerId) Gets the Broker Ids mapped to a BrokerConstrainer.
BrokerList	getBrokersForBrokerConstrainer(Id brokerConstrainerId) Gets the Brokers mapped to a BrokerConstrainer.
Distributor	getDistributor() Gets the Distributor associated with this session.
Id	getDistributorId() Gets the Distributor Id associated with this session.
void	useComparativeBrokerConstrainerRuleView() 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	usePlenaryBrokerConstrainerRuleView() A complete view of the BrokerConstrainer and Broker 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.

canLookupBrokerConstrainerRules

boolean canLookupBrokerConstrainerRules()

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

useComparativeBrokerConstrainerRuleView

void useComparativeBrokerConstrainerRuleView()

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.

usePlenaryBrokerConstrainerRuleView

void usePlenaryBrokerConstrainerRuleView()

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

getBrokerConstrainerIdsForBroker

IdList getBrokerConstrainerIdsForBroker(Id distributorId)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

Gets the BrokerConstrainer Id associated with a Broker.

Parameters:

distributorId - Id of the Broker

Returns:

the broker constrainer Ids

Throws:

NotFoundException - distributorId is not found

NullArgumentException - distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBrokerConstrainersForBroker

BrokerConstrainerList getBrokerConstrainersForBroker(Id distributorId)
                                                     throws NotFoundException,
                                                            OperationFailedException,
                                                            PermissionDeniedException

Gets the BrokerConstrainer associated with a Broker.

Parameters:

distributorId - Id of the Broker

Returns:

the broker constrainers

Throws:

NotFoundException - distributorId is not found

NullArgumentException - distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBrokerIdsForBrokerConstrainer

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

Gets the Broker Ids mapped to a BrokerConstrainer.

Parameters:

brokerConstrainerId - Id of a BrokerConstrainer

Returns:

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

getBrokersForBrokerConstrainer

BrokerList getBrokersForBrokerConstrainer(Id brokerConstrainerId)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Gets the Brokers mapped to a BrokerConstrainer.

Parameters:

brokerConstrainerId - Id of a BrokerConstrainer

Returns:

list of brokers

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.