org.osid.provisioning.rules

Interface BrokerProcessorLookupSession

All Superinterfaces:

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

public interface BrokerProcessorLookupSession
extends OsidSession

This session provides methods for retrieving BrokerProcessors.

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 processor methods in this session operate, retrieve and pertain to broker processor defined explicitly in the current distributor. Using an isolated view is useful for managing BrokerProcessors with the BrokerProcessorAdminSession.
• federated distributor view: All broker processor methods in this session operate, retrieve and pertain to all broker processor defined in this distributor and any other broker processor implicitly available in this distributor through distributor inheritence.
• active broker processor view: All broker processor lookup methods return active broker processors.
• any status broker processor view: Broker processors of any active and 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	canLookupBrokerProcessors() Tests if this user can perform BrokerProcessors lookups.
BrokerProcessor	getBrokerProcessor(Id brokerProcessorId) Gets the BrokerProcessor specified by its Id.
BrokerProcessorList	getBrokerProcessors() Gets all BrokerProcessors.
BrokerProcessorList	getBrokerProcessorsByGenusType(Type brokerProcessorGenusType) Gets a BrokerProcessorList corresponding to the given broker processor genus Type which does not include broker processor of genus types derived from the specified Type.
BrokerProcessorList	getBrokerProcessorsByIds(IdList brokerProcessorIds) Gets a BrokerProcessorList corresponding to the given IdList.
BrokerProcessorList	getBrokerProcessorsByParentGenusType(Type brokerProcessorGenusType) Gets a BrokerProcessorList corresponding to the given broker processor genus Type and include any additional broker processor with genus types derived from the specified Type.
BrokerProcessorList	getBrokerProcessorsByRecordType(Type brokerProcessorRecordType) Gets a BrokerProcessorList containing the given broker processor record Type.
Distributor	getDistributor() Gets the Distributor associated with this session.
Id	getDistributorId() Gets the Distributor Id associated with this session.
void	useActiveBrokerProcessorView() Only active broker processors are returned by methods in this session.
void	useAnyStatusBrokerProcessorView() All active and inactive broker processors are returned by methods in this session.
void	useComparativeBrokerProcessorView() 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	usePlenaryBrokerProcessorView() A complete view of the BrokerProcessor 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.

canLookupBrokerProcessors

boolean canLookupBrokerProcessors()

Tests if this user can perform BrokerProcessors 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.

useComparativeBrokerProcessorView

void useComparativeBrokerProcessorView()

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.

usePlenaryBrokerProcessorView

void usePlenaryBrokerProcessorView()

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

useActiveBrokerProcessorView

void useActiveBrokerProcessorView()

Only active broker processors are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyStatusBrokerProcessorView

void useAnyStatusBrokerProcessorView()

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

Compliance:

mandatory - This method is must be implemented.

getBrokerProcessor

BrokerProcessor getBrokerProcessor(Id brokerProcessorId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

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

Parameters:

brokerProcessorId - Id of the BrokerProcessor

Returns:

the broker processor

Throws:

NotFoundException - brokerProcessorId not found

NullArgumentException - brokerProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getBrokerProcessorsByIds

BrokerProcessorList getBrokerProcessorsByIds(IdList brokerProcessorIds)
                                             throws NotFoundException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

Gets a BrokerProcessorList corresponding to the given IdList. In plenary mode, the returned list contains all of the broker processor 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 BrokerProcessors may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, broker processors are returned that are currently active. In any status mode, active and inactive broker processors are returned.

Parameters:

brokerProcessorIds - the list of Ids to retrieve

Returns:

the returned BrokerProcessor list

Throws:

NotFoundException - an Id was not found

NullArgumentException - brokerProcessorIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBrokerProcessorsByGenusType

BrokerProcessorList getBrokerProcessorsByGenusType(Type brokerProcessorGenusType)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

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

Parameters:

brokerProcessorGenusType - a broker processor genus type

Returns:

the returned BrokerProcessor list

Throws:

NullArgumentException - brokerProcessorGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBrokerProcessorsByParentGenusType

BrokerProcessorList getBrokerProcessorsByParentGenusType(Type brokerProcessorGenusType)
                                                         throws OperationFailedException,
                                                                PermissionDeniedException

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

Parameters:

brokerProcessorGenusType - a broker processor genus type

Returns:

the returned BrokerProcessor list

Throws:

NullArgumentException - brokerProcessorGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBrokerProcessorsByRecordType

BrokerProcessorList getBrokerProcessorsByRecordType(Type brokerProcessorRecordType)
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

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

Parameters:

brokerProcessorRecordType - a broker processor record type

Returns:

the returned BrokerProcessor list

Throws:

NullArgumentException - brokerProcessorRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBrokerProcessors

BrokerProcessorList getBrokerProcessors()
                                        throws OperationFailedException,
                                               PermissionDeniedException

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

Returns:

the returned BrokerProcessor list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.