Interface HoldSearchSession

All Superinterfaces:

AutoCloseable, Closeable, HoldQuerySession, OsidSession, OsidSession

public interface HoldSearchSession
extends HoldQuerySession

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

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

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Modifier and Type	Method	Description
HoldQuery	getHoldQueryFromInspector(HoldQueryInspector holdQueryInspector)	Gets a hold query from an inspector.
HoldSearchResults	getHoldsBySearch(HoldQuery holdQuery, HoldSearch holdSearch)	Gets the search results matching the given search query using the given search.
HoldSearch	getHoldSearch()	Gets a hold search.
HoldSearchOrder	getHoldSearchOrder()	Gets a hold search order.

Methods inherited from interface Closeable

close

Methods inherited from interface HoldQuerySession

canSearchHolds, getHoldQuery, getHoldsByQuery, getOubliette, getOublietteId, useFederatedOublietteView, useIsolatedOublietteView

Modifier and Type	Method	Description
boolean	canSearchHolds()	Tests if this user can perform Hold lookups.
HoldQuery	getHoldQuery()	Gets a hold query.
HoldList	getHoldsByQuery(HoldQuery holdQuery)	Gets a list of Holds matching the given hold query.
Oubliette	getOubliette()	Gets the Oubliette associated with this session.
Id	getOublietteId()	Gets the Oubliette Id associated with this session.
void	useFederatedOublietteView()	Federates the view for methods in this session.
void	useIsolatedOublietteView()	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

getHoldSearch

HoldSearch getHoldSearch()

Gets a hold search.

Returns:

the hold search

Compliance:

mandatory - This method must be implemented.

getHoldSearchOrder

HoldSearchOrder getHoldSearchOrder()

Gets a hold search order. The HoldSearchOrder is supplied to a HoldSearch to specify the ordering of results.

Returns:

the hold search order

Compliance:

mandatory - This method must be implemented.

getHoldsBySearch

HoldSearchResults getHoldsBySearch(HoldQuery holdQuery,
 HoldSearch holdSearch)
                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

holdQuery - the hold query

holdSearch - the hold search

Returns:

the hold search results

Throws:

NullArgumentException - holdQuery or holdSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - holdQuery or holdSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getHoldQueryFromInspector

HoldQuery getHoldQueryFromInspector(HoldQueryInspector holdQueryInspector)

Gets a hold query from an inspector. The inspector is available from a HoldSearchResults .

Parameters:

holdQueryInspector - a hold query inspector

Returns:

the hold query

Throws:

NullArgumentException - holdQueryInspector is null

UnsupportedException - holdQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.