Interface InstallationSearchSession

All Superinterfaces:

AutoCloseable, Closeable, InstallationQuerySession, OsidSession, OsidSession

public interface InstallationSearchSession
extends InstallationQuerySession

This session provides methods for searching Installations . The search query is constructed using the InstallationQuery . The installation record Type also specifies the record for the installation query.

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

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

Method Summary

Modifier and Type	Method	Description
InstallationSearchResults	getInstallationsBySearch(InstallationQuery installationQuery, InstallationSearch installationSearch)	Gets the search results matching the given search query using the given search.
InstallationSearch	getInstallationSearch()	Gets an installation search.
InstallationSearchOrder	getInstallationSearchOrder()	Gets an installation search order.
InstallationQuery	getInstallationsQueryFromInspector(InstallationQueryInspector installatonQueryInspector)	Gets an installation query from an inspector.

Methods inherited from interface Closeable

close

Methods inherited from interface InstallationQuerySession

canSearchInstallations, getInstallationQuery, getInstallationsByQuery, getSite, getSiteId, useDenormalizedDependencyView, useDenormalizedVersionView, useNormalizedDependencyView, useNormalizedVersionView

Modifier and Type	Method	Description
boolean	canSearchInstallations()	Tests if this user can perform Installation searches.
InstallationQuery	getInstallationQuery()	Gets an installation query.
InstallationList	getInstallationsByQuery(InstallationQuery installationQuery)	Gets a list of Installations matching the given installation query.
Site	getSite()	Gets the Site associated with this session.
Id	getSiteId()	Gets the Site Id associated with this session.
void	useDenormalizedDependencyView()	A denormalized view returns all dependencies.
void	useDenormalizedVersionView()	All versions of the same installation are returned.
void	useNormalizedDependencyView()	A normalized view uses a single Installation to represent a set of package dependencies.
void	useNormalizedVersionView()	The returns from the lookup methods may omit multiple versions of the same installation.

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

getInstallationSearch

InstallationSearch getInstallationSearch()

Gets an installation search.

Returns:

the installation search

Compliance:

mandatory - This method must be implemented.

getInstallationSearchOrder

InstallationSearchOrder getInstallationSearchOrder()

Gets an installation search order. The InstallationSearchOrder is supplied to an InstallationSearch to specify the ordering of results.

Returns:

the installation search order

Compliance:

mandatory - This method must be implemented.

getInstallationsBySearch

InstallationSearchResults getInstallationsBySearch(InstallationQuery installationQuery,
 InstallationSearch installationSearch)
                                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

installationQuery - the installation query

installationSearch - the installation search

Returns:

the returned search results

Throws:

NullArgumentException - installationQuery or installationSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - installationSearch or installationQuery is not of this service

Compliance:

mandatory - This method must be implemented.

getInstallationsQueryFromInspector

InstallationQuery getInstallationsQueryFromInspector(InstallationQueryInspector installatonQueryInspector)

Gets an installation query from an inspector. The inspector is available from a InstallationSearchResults .

Parameters:

installatonQueryInspector - an installation query inspector

Returns:

the installaton query

Throws:

NullArgumentException - installationQueryInspector is null

UnsupportedException - installationQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.