Interface SystemSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, SystemQuerySession

public interface SystemSearchSession
extends SystemQuerySession

This session provides methods for searching among Systems . The search query is constructed using the SystemQuery .

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

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

Method Summary

Modifier and Type	Method	Description
SystemQuery	getSystemQueryFromInspector(SystemQueryInspector systemQueryInspector)	Gets a system query from an inspector.
SystemSearchResults	getSystemsBySearch(SystemQuery systemQuery, SystemSearch systemSearch)	Gets the search results matching the given search query using the given search.
SystemSearch	getSystemSearch()	Gets a system search.
SystemSearchOrder	getSystemSearchOrder()	Gets a system 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 SystemQuerySession

canSearchSystems, getSystemQuery, getSystemsByQuery

Modifier and Type	Method	Description
boolean	canSearchSystems()	Tests if this user can perform System searches.
SystemQuery	getSystemQuery()	Gets a system query.
SystemList	getSystemsByQuery(SystemQuery systemQuery)	Gets a list of Systems matching the given system query.

Method Details

getSystemSearch

SystemSearch getSystemSearch()

Gets a system search.

Returns:

the system search

Compliance:

mandatory - This method must be implemented.

getSystemSearchOrder

SystemSearchOrder getSystemSearchOrder()

Gets a system search order. The SystemSearchOrder is supplied to a SystemSearch to specify the ordering of results.

Returns:

the system search order

Compliance:

mandatory - This method must be implemented.

getSystemsBySearch

SystemSearchResults getSystemsBySearch(SystemQuery systemQuery,
 SystemSearch systemSearch)
                                throws OperationFailedException,
PermissionDeniedException

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

Parameters:

systemQuery - the system query

systemSearch - the system search

Returns:

the system search results

Throws:

NullArgumentException - systemQuery or systemSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - systemQuery or systemSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getSystemQueryFromInspector

SystemQuery getSystemQueryFromInspector(SystemQueryInspector systemQueryInspector)

Gets a system query from an inspector. The inspector is available from a SystemSearchResults .

Parameters:

systemQueryInspector - a system query inspector

Returns:

the system query

Throws:

NullArgumentException - systemQueryInspector is null

UnsupportedException - systemQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.