org.osid.provisioning.rules

Interface PoolConstrainerEnablerQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

PoolConstrainerEnablerSearchSession

public interface PoolConstrainerEnablerQuerySession
extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

Pool constrainer enablers may have a query record indicated by their respective record types. The query record is accessed via the PoolConstrainerEnablerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchPoolConstrainerEnablers() Tests if this user can perform PoolConstrainerEnabler lookups.
Distributor	getDistributor() Gets the Distributor associated with this session.
Id	getDistributorId() Gets the Distributor Id associated with this session.
PoolConstrainerEnablerQuery	getPoolConstrainerEnablerQuery() Gets a pool constrainer enabler query.
PoolConstrainerEnablerList	getPoolConstrainerEnablersByQuery(PoolConstrainerEnablerQuery poolConstrainerEnablerQuery) Gets a list of PoolConstrainerEnablers matching the given search.
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.

canSearchPoolConstrainerEnablers

boolean canSearchPoolConstrainerEnablers()

Tests if this user can perform PoolConstrainerEnabler 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 pool constrainer enablers 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.

getPoolConstrainerEnablerQuery

PoolConstrainerEnablerQuery getPoolConstrainerEnablerQuery()

Gets a pool constrainer enabler query.

Returns:

the pool constrainer enabler query

Compliance:

mandatory - This method must be implemented.

getPoolConstrainerEnablersByQuery

PoolConstrainerEnablerList getPoolConstrainerEnablersByQuery(PoolConstrainerEnablerQuery poolConstrainerEnablerQuery)
                                                             throws OperationFailedException,
                                                                    PermissionDeniedException

Gets a list of PoolConstrainerEnablers matching the given search.

Parameters:

poolConstrainerEnablerQuery - the search query

Returns:

the returned PoolConstrainerEnablerList

Throws:

NullArgumentException - poolConstrainerEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - poolConstrainerEnablerQuery is not of this service

Compliance:

mandatory - This method must be implemented.