Interface DispatchSearchSession

All Superinterfaces:

AutoCloseable, Closeable, DispatchQuerySession, OsidSession, OsidSession

public interface DispatchSearchSession
extends DispatchQuerySession

This session provides methods for searching Dispatches. The search query is constructed using the DispatchQuery. The dispatch record Type also specifies the record for the dispatch query.

getDispatchesByQuery() is the basic search method and returns a list of Dispatch elements. A more advanced search may be performed with getDispatchesBySearch(). It accepts a DispatchSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getDispatchesBySearch() returns a DispatchSearchResults that can be used to access the resulting DispatchList or be used to perform a search within the result set through DispatchSearch.

Dispatches may have a query record indicated by their respective record types. The query record is accessed via the DispatchQuery. The returns in this session may not be cast directly to these interfaces.

Method Summary

Modifier and Type	Method	Description
DispatchSearchResults	getDispatchesBySearch(DispatchQuery dispatchQuery, DispatchSearch dispatchSearch)	Gets the search results matching the given search.
DispatchQuery	getDispatchQueryFromInspector(DispatchQueryInspector dispatchQueryInspector)	Gets an entry query from an inspector.
DispatchSearch	getDispatchSearch()	Gets a dispatch search.
DispatchSearchOrder	getDispatchSearchOrder()	Gets a dispatch search order.

Methods inherited from interface Closeable

close

Methods inherited from interface DispatchQuerySession

canSearchDispatches, getDispatchesByQuery, getDispatchQuery, getPublisher, getPublisherId, useFederatedPublisherView, useIsolatedPublisherView

Modifier and Type	Method	Description
boolean	canSearchDispatches()	Tests if this user can perform Dispatch searches.
DispatchList	getDispatchesByQuery(DispatchQuery dispatchQuery)	Gets a list of Dispatches matching the given dispatch query.
DispatchQuery	getDispatchQuery()	Gets a dispatch query.
Publisher	getPublisher()	Gets the Publisher associated with this session.
Id	getPublisherId()	Gets the Publisher Id associated with this session.
void	useFederatedPublisherView()	Federates the view for methods in this session.
void	useIsolatedPublisherView()	Isolates the view for methods in this session.

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

getDispatchSearch

DispatchSearch getDispatchSearch()

Gets a dispatch search.

Returns:

the dispatch search

Compliance:

mandatory - This method must be implemented.

getDispatchSearchOrder

DispatchSearchOrder getDispatchSearchOrder()

Gets a dispatch search order. The DispatchSearchOrder is supplied to a DispatchSearch to specify the ordering of results.

Returns:

the dispatch search order

Compliance:

mandatory - This method must be implemented.

getDispatchesBySearch

DispatchSearchResults getDispatchesBySearch(DispatchQuery dispatchQuery,
 DispatchSearch dispatchSearch)
                                     throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

dispatchQuery - the dispatch query

dispatchSearch - the dispatch search

Returns:

the dispatch search results

Throws:

NullArgumentException - dispatchQuery or dispatchSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - dispatchQuery or dispatchSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getDispatchQueryFromInspector

DispatchQuery getDispatchQueryFromInspector(DispatchQueryInspector dispatchQueryInspector)

Gets an entry query from an inspector. The inspector is available from an DispatchSearchResults.

Parameters:

dispatchQueryInspector - a query inspector

Returns:

the entry query

Throws:

NullArgumentException - dispatchQueryInspector is null

UnsupportedException - dispatchQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.