Interface AntimatroidSearchSession

All Superinterfaces:

AntimatroidQuerySession, AutoCloseable, Closeable, OsidSession, OsidSession

public interface AntimatroidSearchSession
extends AntimatroidQuerySession

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

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

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

Method Summary

Modifier and Type	Method	Description
AntimatroidQuery	getAntimatroidQueryFromInspector(AntimatroidQueryInspector antimatroidQueryInspector)	Gets an antimatroid query from an inspector.
AntimatroidSearchResults	getAntimatroidsBySearch(AntimatroidQuery antimatroidQuery, AntimatroidSearch antimatroidSearch)	Gets the search results matching the given search query using the given search.
AntimatroidSearch	getAntimatroidSearch()	Gets an antimatroid search.
AntimatroidSearchOrder	getAntimatroidSearchOrder()	Gets an antimatroid search order.

Methods inherited from interface AntimatroidQuerySession

canSearchAntimatroids, getAntimatroidQuery, getAntimatroidsByQuery

Modifier and Type	Method	Description
boolean	canSearchAntimatroids()	Tests if this user can perform Antimatroid searches.
AntimatroidQuery	getAntimatroidQuery()	Gets an antimatroid query.
AntimatroidList	getAntimatroidsByQuery(AntimatroidQuery antimatroidQuery)	Gets a list of Antimatroids matching the given antimatroid query.

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.

Method Details

getAntimatroidSearch

AntimatroidSearch getAntimatroidSearch()

Gets an antimatroid search.

Returns:

the antimatroid search

Compliance:

mandatory - This method must be implemented.

getAntimatroidSearchOrder

AntimatroidSearchOrder getAntimatroidSearchOrder()

Gets an antimatroid search order. The AntimatroidSearchOrder is supplied to an AntimatroidSearch to specify the ordering of results.

Returns:

the antimatroid search order

Compliance:

mandatory - This method must be implemented.

getAntimatroidsBySearch

AntimatroidSearchResults getAntimatroidsBySearch(AntimatroidQuery antimatroidQuery,
 AntimatroidSearch antimatroidSearch)
                                          throws OperationFailedException,
PermissionDeniedException

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

Parameters:

antimatroidQuery - the antimatroid query

antimatroidSearch - the antimatroid search

Returns:

the antimatroid search results

Throws:

NullArgumentException - antimatroidQuery or antimatroidSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - antimatroidQuery or antimatroidSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getAntimatroidQueryFromInspector

AntimatroidQuery getAntimatroidQueryFromInspector(AntimatroidQueryInspector antimatroidQueryInspector)

Gets an antimatroid query from an inspector. The inspector is available from an AntimatroidSearchResults .

Parameters:

antimatroidQueryInspector - an antimatroid query inspector

Returns:

the antimatroid query

Throws:

NullArgumentException - antimatroidQueryInspector is null

UnsupportedException - antimatroidQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.