org.osid.provisioning

Interface DistributorQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

DistributorSearchSession

public interface DistributorQuerySession
extends OsidSession

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

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchDistributors() Tests if this user can perform Distributor searches.
DistributorQuery	getDistributorQuery() Gets a distributor query.
DistributorList	getDistributorsByQuery(DistributorQuery distributorQuery) Gets a list of Distributors matching the given distributor query.

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

canSearchDistributors

boolean canSearchDistributors()

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

getDistributorQuery

DistributorQuery getDistributorQuery()

Gets a distributor query.

Returns:

the distributor query

Compliance:

mandatory - This method must be implemented.

getDistributorsByQuery

DistributorList getDistributorsByQuery(DistributorQuery distributorQuery)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Gets a list of Distributors matching the given distributor query.

Parameters:

distributorQuery - the distributor query

Returns:

the returned DistributorList

Throws:

NullArgumentException - distributorQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - distributorQuery is not of this service

Compliance:

mandatory - This method must be implemented.