org.osid.hold

Interface OublietteSearchSession

All Superinterfaces:

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

public interface OublietteSearchSession
extends OublietteQuerySession

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

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

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

Method Summary

Methods

Modifier and Type	Method and Description
OublietteSearchResults	getOublietteBySearch(OublietteQuery oublietteQuery, OublietteSearch oublietteSearch) Gets the search results matching the given search query using the given search.
OublietteQuery	getOublietteQueryFromInspector(OublietteQueryInspector oublietteQueryInspector) Gets an oubliette query from an inspector.
OublietteSearch	getOublietteSearch() Gets an oubliette search.
OublietteSearchOrder	getOublietteSearchOrder() Gets an oubliette search order.

Methods inherited from interface org.osid.hold.OublietteQuerySession

canSearchOubliettes, getOublietteQuery, getOubliettesByQuery

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

getOublietteSearch

OublietteSearch getOublietteSearch()

Gets an oubliette search.

Returns:

the oubliette search

Compliance:

mandatory - This method must be implemented.

getOublietteSearchOrder

OublietteSearchOrder getOublietteSearchOrder()

Gets an oubliette search order. The OublietteSearchOrder is supplied to a OublietteSearch to specify the ordering of results.

Returns:

the oubliette search order

Compliance:

mandatory - This method must be implemented.

getOublietteBySearch

OublietteSearchResults getOublietteBySearch(OublietteQuery oublietteQuery,
                                          OublietteSearch oublietteSearch)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

oublietteQuery - the oubliette query

oublietteSearch - the oubliette search

Returns:

the oubliette search results

Throws:

NullArgumentException - oublietteQuery or oublietteSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - oublietteQuery or oublietteSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getOublietteQueryFromInspector

OublietteQuery getOublietteQueryFromInspector(OublietteQueryInspector oublietteQueryInspector)

Gets an oubliette query from an inspector. The inspector is available from a OublietteSearchResults.

Parameters:

oublietteQueryInspector - an oubliette query inspector

Returns:

the oubliette query

Throws:

NullArgumentException - oublietteQueryInspector is null

UnsupportedException - oublietteQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.