org.osid.provisioning.rules

Interface BrokerConstrainerEnablerLookupSession

All Superinterfaces:

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

public interface BrokerConstrainerEnablerLookupSession
extends OsidSession

This session provides methods for retrieving BrokerConstrainerEnablers.

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition
• isolated distributor view: All broker constrainer enabler methods in this session operate, retrieve and pertain to broker constrainer enablers defined explicitly in the current distributor. Using an isolated view is useful for managing BrokerConstrainerEnablers with the BrokerConstrainerEnablerAdminSession.
• federated distributor view: All broker constrainer enabler 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.
• active broker constrainer enabler view: All broker constrainer enabler lookup methods return active broker constrainer enablers.
• any status broker constrainer enabler view: Broker constrainer enablers of any active or inactive status are returned from methods.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedDistributorView() and useIsolatedDistributorView() behave as a radio group and one should be selected before invoking the methods in this session.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupBrokerConstrainerEnablers() Tests if this user can perform BrokerConstrainerEnablers lookups.
BrokerConstrainerEnabler	getBrokerConstrainerEnabler(Id brokerConstrainerEnablerId) Gets the BrokerConstrainerEnabler specified by its Id.
BrokerConstrainerEnablerList	getBrokerConstrainerEnablers() Gets all BrokerConstrainerEnablers.
BrokerConstrainerEnablerList	getBrokerConstrainerEnablersByGenusType(Type brokerConstrainerEnablerGenusType) Gets a BrokerConstrainerEnablerList corresponding to the given broker constrainer enabler genus Type which does not include broker constrainer enablers of genus types derived from the specified Type.
BrokerConstrainerEnablerList	getBrokerConstrainerEnablersByIds(IdList brokerConstrainerEnablerIds) Gets a BrokerConstrainerEnablerList corresponding to the given IdList.
BrokerConstrainerEnablerList	getBrokerConstrainerEnablersByParentGenusType(Type brokerConstrainerEnablerGenusType) Gets a BrokerConstrainerEnablerList corresponding to the given broker constrainer enabler genus Type and include any additional broker constrainer enablers with genus types derived from the specified Type.
BrokerConstrainerEnablerList	getBrokerConstrainerEnablersByRecordType(Type brokerConstrainerEnablerRecordType) Gets a BrokerConstrainerEnablerList containing the given broker constrainer enabler record Type.
BrokerConstrainerEnablerList	getBrokerConstrainerEnablersOnDate(DateTime from, DateTime to) Gets a BrokerConstrainerEnablerList effective for the entire the given date range inclusive but not confisned to the date range for any agent.
BrokerConstrainerEnablerList	getBrokerConstrainerEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) Gets a BrokerConstrainerEnablerList effective for the entire the given date range inclusive but not confisned to the date range and evaluated against the given agent.
Distributor	getDistributor() Gets the Distributor associated with this session.
Id	getDistributorId() Gets the Distributor Id associated with this session.
void	useActiveBrokerConstrainerEnablerView() Only active broker constrainer enablers are current are returned by methods in this session.
void	useAnyStatusBrokerConstrainerEnablerView() All active and inactive broker constrainer enablers are returned by methods in this session.
void	useComparativeBrokerConstrainerEnablerView() 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	usePlenaryBrokerConstrainerEnablerView() A complete view of the BrokerConstrainerEnabler 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.

canLookupBrokerConstrainerEnablers

boolean canLookupBrokerConstrainerEnablers()

Tests if this user can perform BrokerConstrainerEnablers lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeBrokerConstrainerEnablerView

void useComparativeBrokerConstrainerEnablerView()

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.

usePlenaryBrokerConstrainerEnablerView

void usePlenaryBrokerConstrainerEnablerView()

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

useActiveBrokerConstrainerEnablerView

void useActiveBrokerConstrainerEnablerView()

Only active broker constrainer enablers are current are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyStatusBrokerConstrainerEnablerView

void useAnyStatusBrokerConstrainerEnablerView()

All active and inactive broker constrainer enablers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

getBrokerConstrainerEnabler

BrokerConstrainerEnabler getBrokerConstrainerEnabler(Id brokerConstrainerEnablerId)
                                                     throws NotFoundException,
                                                            OperationFailedException,
                                                            PermissionDeniedException

Gets the BrokerConstrainerEnabler specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned BrokerConstrainerEnabler may have a different Id than requested, such as the case where a duplicate Id was assigned to a BrokerConstrainerEnabler and retained for compatibility. In active mode, broker constrainer enablers are returned that are currently active. In any status mode, active and inactive broker constrainer enablers are returned.

Parameters:

brokerConstrainerEnablerId - Id of the BrokerConstrainerEnabler

Returns:

the broker constrainer enabler

Throws:

NotFoundException - brokerConstrainerEnablerId not found

NullArgumentException - brokerConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getBrokerConstrainerEnablersByIds

BrokerConstrainerEnablerList getBrokerConstrainerEnablersByIds(IdList brokerConstrainerEnablerIds)
                                                               throws NotFoundException,
                                                                      OperationFailedException,
                                                                      PermissionDeniedException

Gets a BrokerConstrainerEnablerList corresponding to the given IdList. In plenary mode, the returned list contains all of the broker constrainer enablers specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible BrokerConstrainerEnablers may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, broker constrainer enablers are returned that are currently active. In any status mode, active and inactive broker constrainer enablers are returned.

Parameters:

brokerConstrainerEnablerIds - the list of Ids to retrieve

Returns:

the returned BrokerConstrainerEnabler list

Throws:

NotFoundException - an Id was not found

NullArgumentException - brokerConstrainerEnablerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBrokerConstrainerEnablersByGenusType

BrokerConstrainerEnablerList getBrokerConstrainerEnablersByGenusType(Type brokerConstrainerEnablerGenusType)
                                                                     throws OperationFailedException,
                                                                            PermissionDeniedException

Gets a BrokerConstrainerEnablerList corresponding to the given broker constrainer enabler genus Type which does not include broker constrainer enablers of genus types derived from the specified Type. In plenary mode, the returned list contains all known broker constrainer enablers or an error results. Otherwise, the returned list may contain only those broker constrainer enablers that are accessible through this session. In active mode, broker constrainer enablers are returned that are currently active. In any status mode, active and inactive broker constrainer enablers are returned.

Parameters:

brokerConstrainerEnablerGenusType - a broker constrainer enabler genus type

Returns:

the returned BrokerConstrainerEnabler list

Throws:

NullArgumentException - brokerConstrainerEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBrokerConstrainerEnablersByParentGenusType

BrokerConstrainerEnablerList getBrokerConstrainerEnablersByParentGenusType(Type brokerConstrainerEnablerGenusType)
                                                                           throws OperationFailedException,
                                                                                  PermissionDeniedException

Gets a BrokerConstrainerEnablerList corresponding to the given broker constrainer enabler genus Type and include any additional broker constrainer enablers with genus types derived from the specified Type. In plenary mode, the returned list contains all known broker constrainer enablers or an error results. Otherwise, the returned list may contain only those broker constrainer enablers that are accessible through this session. In active mode, broker constrainer enablers are returned that are currently active. In any status mode, active and inactive broker constrainer enablers are returned.

Parameters:

brokerConstrainerEnablerGenusType - a broker constrainer enabler genus type

Returns:

the returned BrokerConstrainerEnabler list

Throws:

NullArgumentException - brokerConstrainerEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBrokerConstrainerEnablersByRecordType

BrokerConstrainerEnablerList getBrokerConstrainerEnablersByRecordType(Type brokerConstrainerEnablerRecordType)
                                                                      throws OperationFailedException,
                                                                             PermissionDeniedException

Gets a BrokerConstrainerEnablerList containing the given broker constrainer enabler record Type. In plenary mode, the returned list contains all known broker constrainer enablers or an error results. Otherwise, the returned list may contain only those broker constrainer enablers that are accessible through this session. In active mode, broker constrainer enablers are returned that are currently active. In any status mode, active and inactive broker constrainer enablers are returned.

Parameters:

brokerConstrainerEnablerRecordType - a broker constrainer enabler record type

Returns:

the returned BrokerConstrainerEnabler list

Throws:

NullArgumentException - brokerConstrainerEnablerRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBrokerConstrainerEnablersOnDate

BrokerConstrainerEnablerList getBrokerConstrainerEnablersOnDate(DateTime from,
                                                              DateTime to)
                                                                throws OperationFailedException,
                                                                       PermissionDeniedException

Gets a BrokerConstrainerEnablerList effective for the entire the given date range inclusive but not confisned to the date range for any agent. In plenary mode, the returned list contains all known broker constrainer enablers or an error results. Otherwise, the returned list may contain only those broker constrainer enablers that are accessible through this session. In active mode, broker constrainer enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive broker constrainer enablers are returned.

Parameters:

from - a start date

to - an end date

Returns:

the returned BrokerConstrainerEnabler list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBrokerConstrainerEnablersOnDateWithAgent

BrokerConstrainerEnablerList getBrokerConstrainerEnablersOnDateWithAgent(Id agentId,
                                                                       DateTime from,
                                                                       DateTime to)
                                                                         throws OperationFailedException,
                                                                                PermissionDeniedException

Gets a BrokerConstrainerEnablerList effective for the entire the given date range inclusive but not confisned to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known broker constrainer enablers or an error results. Otherwise, the returned list may contain only those broker constrainer enablers that are accessible through this session. In active mode, broker constrainer enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive broker constrainer enablers are returned.

Parameters:

agentId - an agent Id

from - a start date

to - an end date

Returns:

the returned BrokerConstrainerEnabler list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - agentId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBrokerConstrainerEnablers

BrokerConstrainerEnablerList getBrokerConstrainerEnablers()
                                                          throws OperationFailedException,
                                                                 PermissionDeniedException

Gets all BrokerConstrainerEnablers. In plenary mode, the returned list contains all known broker constrainer enablers or an error results. Otherwise, the returned list may contain only those broker constrainer enablers that are accessible through this session. In active mode, broker constrainer enablers are returned that are currently active. In any status mode, active and inactive broker constrainer enablers are returned.

Returns:

the returned BrokerConstrainerEnabler list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.