Interface DepotSearchSession

All Superinterfaces:

AutoCloseable, Closeable, DepotQuerySession, OsidSession, OsidSession

public interface DepotSearchSession
extends DepotQuerySession

This session provides methods for searching among Depots . The search query is constructed using the DepotQuery .

getDepotsByQuery() is the basic search method and returns a list of Depot objects.A more advanced search may be performed with getDepotsBySearch() .It accepts a DepotSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getDepotsBySearch() returns a DepotSearchResults that can be used to access the resulting DepotList or be used to perform a search within the result set through DepotSearch .

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

Method Summary

Modifier and Type	Method	Description
DepotQuery	getDepotQueryFromInspector(DepotQueryInspector depotQueryInspector)	Gets a depot query from an inspector.
DepotSearchResults	getDepotsBySearch(DepotQuery depotQuery, DepotSearch depotSearch)	Gets the search results matching the given search query using the given search.
DepotSearch	getDepotSearch()	Gets a depot search.
DepotSearchOrder	getDepotSearchOrder()	Gets a depot search order.

Methods inherited from interface Closeable

close

Methods inherited from interface DepotQuerySession

canSearchDepots, getDepotQuery, getDepotsByQuery

Modifier and Type	Method	Description
boolean	canSearchDepots()	Tests if this user can perform Depot searches.
DepotQuery	getDepotQuery()	Gets a depot query.
DepotList	getDepotsByQuery(DepotQuery depotQuery)	Gets a list of Depot objects matching the given depot query.

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

getDepotSearch

DepotSearch getDepotSearch()

Gets a depot search.

Returns:

a depot search

Compliance:

mandatory - This method must be implemented.

getDepotSearchOrder

DepotSearchOrder getDepotSearchOrder()

Gets a depot search order. The DepotSearchOrder is supplied to a DepotSearch to specify the ordering of results.

Returns:

the depot search order

Compliance:

mandatory - This method must be implemented.

getDepotsBySearch

DepotSearchResults getDepotsBySearch(DepotQuery depotQuery,
 DepotSearch depotSearch)
                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

depotQuery - the depot query

depotSearch - the depot search

Returns:

the depot search results

Throws:

NullArgumentException - depotQuery or depotSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - depotQuery or depotSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getDepotQueryFromInspector

DepotQuery getDepotQueryFromInspector(DepotQueryInspector depotQueryInspector)

Gets a depot query from an inspector. The inspector is available from a DepotSearchResults .

Parameters:

depotQueryInspector - a depot query inspector

Returns:

the depot query

Throws:

NullArgumentException - depotQueryInspector is null

UnsupportedException - depotQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.