Interface ResourceSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, ResourceQuerySession

public interface ResourceSearchSession
extends ResourceQuerySession

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

getResourcesByQuery() is the basic search method and returns a list of Resources . A more advanced search may be performed with getResourcesBySearch() .It accepts an ResourceSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getResourcesBySearch() returns an ResourceSearchResults that can be used to access the resulting ResourceList or be used to perform a search within the result set through ResourceList .

This session defines views that offer differing behaviors for searching.

• federated bin view: searches include resources in bins of which this bin is an ancestor in the bin hierarchy
• isolated bin view: searches are restricted to resources in this bin

Resources may have a resource query record indicated by their respective record types. The resource query record is accessed via the ResourceQuery .

Method Summary

Modifier and Type	Method	Description
ResourceQuery	getResourceQueryFromInspector(ResourceQueryInspector resourceQueryInspector)	Gets a resource query from an inspector.
ResourceSearchResults	getResourcesBySearch(ResourceQuery resourceQuery, ResourceSearch resourceSearch)	Gets the search results matching the given search query using the given search.
ResourceSearch	getResourceSearch()	Gets a resource search.
ResourceSearchOrder	getResourceSearchOrder()	Gets a resource search order.

Methods inherited from interface Closeable

close

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.

Methods inherited from interface ResourceQuerySession

canSearchResources, getBin, getBinId, getResourceQuery, getResourcesByQuery, useFederatedBinView, useIsolatedBinView

Modifier and Type	Method	Description
boolean	canSearchResources()	Tests if this user can perform Resource searches.
Bin	getBin()	Gets the Bin associated with this session.
Id	getBinId()	Gets the Bin Id associated with this session.
ResourceQuery	getResourceQuery()	Gets a resource query.
ResourceList	getResourcesByQuery(ResourceQuery resourceQuery)	Gets a list of Resources matching the given resource query.
void	useFederatedBinView()	Federates the view for methods in this session.
void	useIsolatedBinView()	Isolates the view for methods in this session.

Method Details

getResourceSearch

ResourceSearch getResourceSearch()

Gets a resource search.

Returns:

the resource search

Compliance:

mandatory - This method must be implemented.

getResourceSearchOrder

ResourceSearchOrder getResourceSearchOrder()

Gets a resource search order. The ResourceSearchOrder is supplied to a ResourceSearch to specify the ordering of results.

Returns:

the resource search order

Compliance:

mandatory - This method must be implemented.

getResourcesBySearch

ResourceSearchResults getResourcesBySearch(ResourceQuery resourceQuery,
 ResourceSearch resourceSearch)
                                    throws OperationFailedException,
PermissionDeniedException

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

Parameters:

resourceQuery - the resource query

resourceSearch - the resource search

Returns:

the resource search results

Throws:

NullArgumentException - resourceQuery or resourceSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - resourceQuery or resourceSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getResourceQueryFromInspector

ResourceQuery getResourceQueryFromInspector(ResourceQueryInspector resourceQueryInspector)

Gets a resource query from an inspector. The inspector is available from a ResourceSearchResults .

Parameters:

resourceQueryInspector - a resource query inspector

Returns:

the resource query

Throws:

NullArgumentException - resourceQueryInspector is null

UnsupportedException - resourceQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.