org.osid.hold.rules

Interface HoldEnablerSearchSession

All Superinterfaces:

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

public interface HoldEnablerSearchSession
extends HoldEnablerQuerySession

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

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

This session defines views that offer differing behaviors for searching.

• federated hold view: searches include hold enablers in holds of which this hold is an ancestor in the hold hierarchy
• isolated hold view: searches are restricted to hold enablers in this hold

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

Method Summary

Methods

Modifier and Type	Method and Description
HoldEnablerQuery	getHoldEnablerQueryFromInspector(HoldEnablerQueryInspector holdEnablerQueryInspector) Gets a hold enabler query from an inspector.
HoldEnablerSearchResults	getHoldEnablersBySearch(HoldEnablerQuery holdEnablerQuery, HoldEnablerSearch holdEnablerSearch) Gets the search results matching the given search query using the given search.
HoldEnablerSearch	getHoldEnablerSearch() Gets a hold enabler search.
HoldEnablerSearchOrder	getHoldEnablerSearchOrder() Gets a hold enabler search order.

Methods inherited from interface org.osid.hold.rules.HoldEnablerQuerySession

canSearchHoldEnablers, getHoldEnablerQuery, getHoldEnablersByQuery, getOubliette, getOublietteId, useFederatedOublietteView, useIsolatedOublietteView

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

getHoldEnablerSearch

HoldEnablerSearch getHoldEnablerSearch()

Gets a hold enabler search.

Returns:

the hold enabler search

Compliance:

mandatory - This method must be implemented.

getHoldEnablerSearchOrder

HoldEnablerSearchOrder getHoldEnablerSearchOrder()

Gets a hold enabler search order. The HoldEnablerSearchOrder is supplied to a HoldEnablerSearch to specify the ordering of results.

Returns:

the hold enabler search order

Compliance:

mandatory - This method must be implemented.

getHoldEnablersBySearch

HoldEnablerSearchResults getHoldEnablersBySearch(HoldEnablerQuery holdEnablerQuery,
                                               HoldEnablerSearch holdEnablerSearch)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

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

Parameters:

holdEnablerQuery - the hold enabler query

holdEnablerSearch - the hold enabler search

Returns:

the returned search results

Throws:

NullArgumentException - holdEnablerQuery or holdEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - holdEnablerQuery or holdEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getHoldEnablerQueryFromInspector

HoldEnablerQuery getHoldEnablerQueryFromInspector(HoldEnablerQueryInspector holdEnablerQueryInspector)

Gets a hold enabler query from an inspector. The inspector is available from a HoldEnablerSearchResults.

Parameters:

holdEnablerQueryInspector - a hold enabler query inspector

Returns:

the hold enabler query

Throws:

NullArgumentException - holdEnablerQueryInspector is null

UnsupportedException - holdEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.