org.osid.provisioning.rules

Interface BrokerProcessorQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

BrokerProcessorSearchSession

public interface BrokerProcessorQuerySession
extends OsidSession

This session provides methods for searching among BrokerProcessor objects. The search query is constructed using the BrokerProcessorQuery.

This session defines views that offer differing behaviors for searching.

• federated distributor view: searches include broker processor in distributors of which this distributor is an ancestor in the distributor hierarchy
• isolated distributor view: searches are restricted to broker processor in this distributor

broker processor may have a query record indicated by their respective record types. The query record is accessed via the BrokerProcessorQuery.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchBrokerProcessors() Tests if this user can perform BrokerProcessor lookups.
BrokerProcessorQuery	getBrokerProcessorQuery() Gets a broker processor query.
BrokerProcessorList	getBrokerProcessorsByQuery(BrokerProcessorQuery brokerProcessorQuery) Gets a list of BrokerProcessors matching the given search.
Distributor	getDistributor() Gets the Distributor associated with this session.
Id	getDistributorId() Gets the Distributor Id associated with this session.
void	useFederatedDistributorView() Federates the view for methods in this session.
void	useIsolatedDistributorView() Isolates the view for methods in this session.

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.

canSearchBrokerProcessors

boolean canSearchBrokerProcessors()

Tests if this user can perform BrokerProcessor 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 not offer lookup operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method 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 broker 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.

getBrokerProcessorQuery

BrokerProcessorQuery getBrokerProcessorQuery()

Gets a broker processor query.

Returns:

the broker processor query

Compliance:

mandatory - This method must be implemented.

getBrokerProcessorsByQuery

BrokerProcessorList getBrokerProcessorsByQuery(BrokerProcessorQuery brokerProcessorQuery)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Gets a list of BrokerProcessors matching the given search.

Parameters:

brokerProcessorQuery - the search query

Returns:

the returned BrokerProcessorList

Throws:

NullArgumentException - brokerProcessorQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - brokerProcessorQuery is not of this service

Compliance:

mandatory - This method must be implemented.