Interface OublietteSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, 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 an OublietteSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getOublietteBySearch() returns an 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

Modifier and Type	Method	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 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 OublietteQuerySession

canSearchOubliettes, getOublietteQuery, getOubliettesByQuery

Modifier and Type	Method	Description
boolean	canSearchOubliettes()	Tests if this user can perform Oubliette searches.
OublietteQuery	getOublietteQuery()	Gets an oubliette query.
OublietteList	getOubliettesByQuery(OublietteQuery oublietteQuery)	Gets a list of Oubliettes matching the given search.

Method Details

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 an 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 an 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.