Interface ModelSearchSession

All Superinterfaces:

AutoCloseable, Closeable, ModelQuerySession, OsidSession, OsidSession

public interface ModelSearchSession
extends ModelQuerySession

This session provides methods for searching among Models . The search query is constructed using the ModelQuery .

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

This session defines views that offer differing behaviors for searching.

• federated warehouse view: searches include models in warehouses of which this warehouse is an ancestor in the warehouse hierarchy
• isolated warehouse view: searches are restricted to models in this warehouse

Models may have a query record indicated by their respective record types. The queryrecord is accessed via the ModelQuery .

Method Summary

Modifier and Type	Method	Description
ModelQuery	getModelQueryFromInspector(ItemQueryInspector modelQueryInspector)	Gets a model query from an inspector.
ModelSearchResults	getModelsBySearch(ModelQuery modelQuery, ModelSearch modelSearch)	Gets the search results matching the given search query using the given search.
ModelSearch	getModelSearch()	Gets a model search.
ModelSearchOrder	getModelSearchOrder()	Gets a model search order.

Methods inherited from interface Closeable

close

Methods inherited from interface ModelQuerySession

canSearchModels, getModelQuery, getModelsByQuery, getWarehouse, getWarehouseId, useFederatedWarehouseView, useIsolatedWarehouseView

Modifier and Type	Method	Description
boolean	canSearchModels()	Tests if this user can perform Model lookups.
ModelQuery	getModelQuery()	Gets a model query.
ModelList	getModelsByQuery(ModelQuery modelQuery)	Gets a list of Models matching the given model query.
Warehouse	getWarehouse()	Gets the Warehouse associated with this session.
Id	getWarehouseId()	Gets the Warehouse Id associated with this session.
void	useFederatedWarehouseView()	Federates the view for methods in this session.
void	useIsolatedWarehouseView()	Isolates the view for methods in this session.

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

getModelSearch

ModelSearch getModelSearch()

Gets a model search.

Returns:

the model search

Compliance:

mandatory - This method must be implemented.

getModelSearchOrder

ModelSearchOrder getModelSearchOrder()

Gets a model search order. The ModelSearchOrder is supplied to a ModelSearch to specify the ordering of results.

Returns:

the model search order

Compliance:

mandatory - This method must be implemented.

getModelsBySearch

ModelSearchResults getModelsBySearch(ModelQuery modelQuery,
 ModelSearch modelSearch)
                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

modelQuery - the model query

modelSearch - the model search

Returns:

the model search results

Throws:

NullArgumentException - modelQuery or modelSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - modelQuery or modelSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getModelQueryFromInspector

ModelQuery getModelQueryFromInspector(ItemQueryInspector modelQueryInspector)

Gets a model query from an inspector. The inspector is available from a ModelSearchResults .

Parameters:

modelQueryInspector - a model query inspector

Returns:

the model query

Throws:

NullArgumentException - modelQueryInspector is null

UnsupportedException - modelQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.