Interface DispatchConstrainerEnablerSearchSession

All Superinterfaces:

AutoCloseable, Closeable, DispatchConstrainerEnablerQuerySession, OsidSession, OsidSession

public interface DispatchConstrainerEnablerSearchSession
extends DispatchConstrainerEnablerQuerySession

This session provides methods for searching among DispatchConstrainerEnablers . The search query is constructed using the DispatchConstrainerEnablerQuery .

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

This session defines views that offer differing behaviors for searching.

• federated publisher view: searches include dispatch constrainer enablers in publishers of which this publisher is an ancestor in the publisher hierarchy
• isolated publisher view: searches are restricted to dispatch constrainer enablers in this publisher

Dispatch constrainer enablers may have a query record indicated by their respective record types. The query record is accessed via the DispatchConstrainerEnablerQuery .

Method Summary

Modifier and Type	Method	Description
DispatchConstrainerEnablerQuery	getDispatchConstrainerEnablerQueryFromInspector(DispatchConstrainerEnablerQueryInspector dispatchConstrainerEnablerQueryInspector)	Gets a dispatch constrainer enabler query from an inspector.
DispatchConstrainerEnablerSearchResults	getDispatchConstrainerEnablersBySearch(DispatchEnablerQuery dispatchConstrainerEnablerQuery, DispatchConstrainerEnablerSearch dispatchConstrainerEnablerSearch)	Gets the search results matching the given search query using the given search.
DispatchConstrainerEnablerSearch	getDispatchConstrainerEnablerSearch()	Gets a dispatch constrainer enabler search.
DispatchConstrainerEnablerSearchOrder	getDispatchConstrainerEnablerSearchOrder()	Gets a dispatch constrainer enabler search order.

Methods inherited from interface Closeable

close

Methods inherited from interface DispatchConstrainerEnablerQuerySession

canSearchDispatchConstrainerEnablers, getDispatchConstrainerEnablerQuery, getDispatchConstrainerEnablersByQuery, getPublisher, getPublisherId, useFederatedPublisherView, useIsolatedPublisherView

Modifier and Type	Method	Description
boolean	canSearchDispatchConstrainerEnablers()	Tests if this user can perform DispatchConstrainerEnabler searches.
DispatchConstrainerEnablerQuery	getDispatchConstrainerEnablerQuery()	Gets a dispatch constrainer enabler query.
DispatchConstrainerEnablerList	getDispatchConstrainerEnablersByQuery(DispatchConstrainerEnablerQuery dispatchConstrainerEnablerQuery)	Gets a list of DispatchConstrainerEnablers matching the given search.
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

getDispatchConstrainerEnablerSearch

DispatchConstrainerEnablerSearch getDispatchConstrainerEnablerSearch()

Gets a dispatch constrainer enabler search.

Returns:

the dispatch constrainer enabler search

Compliance:

mandatory - This method must be implemented.

getDispatchConstrainerEnablerSearchOrder

DispatchConstrainerEnablerSearchOrder getDispatchConstrainerEnablerSearchOrder()

Gets a dispatch constrainer enabler search order. The DispatchConstrainerEnablerSearchOrder is supplied to a DispatchConstrainerEnablerSearch to specify the ordering of results.

Returns:

the dispatch constrainer enabler search order

Compliance:

mandatory - This method must be implemented.

getDispatchConstrainerEnablersBySearch

DispatchConstrainerEnablerSearchResults getDispatchConstrainerEnablersBySearch(DispatchEnablerQuery dispatchConstrainerEnablerQuery,
 DispatchConstrainerEnablerSearch dispatchConstrainerEnablerSearch)
                                                                        throws OperationFailedException,
PermissionDeniedException

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

Parameters:

dispatchConstrainerEnablerQuery - the dispatch constrainer enabler query

dispatchConstrainerEnablerSearch - the dispatch constrainer enabler search

Returns:

the returned search results

Throws:

NullArgumentException - dispatchConstrainerEnablerQuery or dispatchConstrainerEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - dispatchConstrainerEnablerQuery or dispatchConstrainerEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getDispatchConstrainerEnablerQueryFromInspector

DispatchConstrainerEnablerQuery getDispatchConstrainerEnablerQueryFromInspector(DispatchConstrainerEnablerQueryInspector dispatchConstrainerEnablerQueryInspector)

Gets a dispatch constrainer enabler query from an inspector. The inspector is available from a DispatchConstrainerEnablerSearchResults .

Parameters:

dispatchConstrainerEnablerQueryInspector - a dispatch constrainer enabler query inspector

Returns:

the dispatch constrainer enabler query

Throws:

NullArgumentException - dispatchConstrainerEnablerQueryInspector is null

UnsupportedException - dispatchConstrainerEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.