org.osid.provisioning

Interface ProvisionQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

ProvisionSearchSession

public interface ProvisionQuerySession
extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

Provisions may have a query record indicated by their respective record types. The query record is accessed via the ProvisionQuery.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchProvisions() Tests if this user can perform Provision lookups.
Distributor	getDistributor() Gets the Distributor associated with this session.
Id	getDistributorId() Gets the Distributor Id associated with this session.
ProvisionQuery	getProvisionQuery() Gets a provision query.
ProvisionList	getProvisionsByQuery(ProvisionQuery provisionQuery) Gets a list of Provisions matching the given provision query,
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.

canSearchProvisions

boolean canSearchProvisions()

Tests if this user can perform Provision 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 provisions 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 searches to this distributor only.

Compliance:

mandatory - This method is must be implemented.

getProvisionQuery

ProvisionQuery getProvisionQuery()

Gets a provision query.

Returns:

the provision query

Compliance:

mandatory - This method must be implemented.

getProvisionsByQuery

ProvisionList getProvisionsByQuery(ProvisionQuery provisionQuery)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Gets a list of Provisions matching the given provision query,

Parameters:

provisionQuery - the provision query

Returns:

the returned ProvisionList

Throws:

NullArgumentException - provisionQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - provisionQuery is not of this service

Compliance:

mandatory - This method must be implemented.