org.osid.subscription

Interface DispatchSearchSession

All Superinterfaces:

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

public interface DispatchSearchSession
extends DispatchQuerySession

This session provides methods for searching Dispatch objects. 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

Methods

Modifier and Type	Method and 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 org.osid.subscription.DispatchQuerySession

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

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

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.