Interface DistributorSearchSession

All Superinterfaces:

AutoCloseable, Closeable, DistributorQuerySession, OsidSession, OsidSession

public interface DistributorSearchSession
extends DistributorQuerySession

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

getDistributorsByQuery() is the basic search method and returns a list of Distributors. A more advanced search may be performed with getDistributorsBySearch().It accepts a DistributorSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getDistributorsBySearch() returns a DistributorSearchResults that can be used to access the resulting DistributorList or be used to perform a search within the result set through DistributorSearch.

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

Method Summary

Modifier and Type	Method	Description
DistributorQuery	getDistributorQueryFromInspector(DistributorQueryInspector distributorQueryInspector)	Gets a distributor query from an inspector.
DistributorSearchResults	getDistributorsBySearch(DistributorQuery distributorQuery, DistributorSearch distributorSearch)	Gets the search results matching the given search query using the given search.
DistributorSearch	getDistributorSearch()	Gets a distributor search.
DistributorSearchOrder	getDistributorSearchOrder()	Gets a distributor search order.

Methods inherited from interface Closeable

close

Methods inherited from interface DistributorQuerySession

canSearchDistributors, getDistributorQuery, getDistributorsByQuery

Modifier and Type	Method	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 OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getDistributorSearch

DistributorSearch getDistributorSearch()

Gets a distributor search.

Returns:

the distributor search

Compliance:

mandatory - This method must be implemented.

getDistributorSearchOrder

DistributorSearchOrder getDistributorSearchOrder()

Gets a distributor search order. The DistributorSearchOrder is supplied to a DistributorSearch to specify the ordering of results.

Returns:

the distributor search order

Compliance:

mandatory - This method must be implemented.

getDistributorsBySearch

DistributorSearchResults getDistributorsBySearch(DistributorQuery distributorQuery,
 DistributorSearch distributorSearch)
                                          throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

distributorQuery - the distributor query

distributorSearch - the distributor search

Returns:

the distributor search results

Throws:

NullArgumentException - distributorQuery or distributorSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - distributorQuery or distributorSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getDistributorQueryFromInspector

DistributorQuery getDistributorQueryFromInspector(DistributorQueryInspector distributorQueryInspector)

Gets a distributor query from an inspector. The inspector is available from a DistributorSearchResults.

Parameters:

distributorQueryInspector - a distributor query inspector

Returns:

the distributor query

Throws:

NullArgumentException - distributorQueryInspector is null

UnsupportedException - distributorQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.