Interface InstallationPackageSearchSession

All Superinterfaces:

AutoCloseable, Closeable, InstallationPackageQuerySession, OsidSession, OsidSession

public interface InstallationPackageSearchSession
extends InstallationPackageQuerySession

This session provides methods for searching InstallationPackages. The search query is constructed using the InstallationPackageQuery. The package record Type also specifies the record for the package query.

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

This session defines views that offer differing behaviors for searching.

• federated depot view: searches include packages in depots of which this depot is a ancestor in the depot hierarchy
• isolated depot view: searches are restricted to packages in this depot
• normalized version view: multiple versions of the same package are suppressed
• denormalized version vew: all versions of an installation are returned
• normalized dependency view: supporting installations upon which other installations depend are suppressed
• denormalized dependency view: all dependencies are returned

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

Method Summary

Modifier and Type	Method	Description
InstallationPackageQuery	getInstallationPackageQueryFromInspector(InstallationPackageQueryInspector installationPackageQueryInspector)	Gets a package query from an inspector.
InstallationPackageSearchResults	getInstallationPackagesBySearch(InstallationPackageQuery installationPackageQuery, InstallationPackageSearch installationPackageSearch)	Gets the search results matching the given search query using the given search.
InstallationPackageSearch	getInstallationPackageSearch()	Gets a package search.
InstallationPackageSearchOrder	getInstallationPackageSearchOrder()	Gets a package search order.

Methods inherited from interface Closeable

close

Methods inherited from interface InstallationPackageQuerySession

canSearchInstallationPackages, getDepot, getDepotId, getInstallationPackageQuery, getInstallationPackagesByQuery, useDenormalizedDependencyView, useDenormalizedVersionView, useFederatedDepotView, useIsolatedDepotView, useNormalizedDependencyView, useNormalizedVersionView

Modifier and Type	Method	Description
boolean	canSearchInstallationPackages()	Tests if this user can perform InstallationPackage searches.
Depot	getDepot()	Gets the Depot associated with this session.
Id	getDepotId()	Gets the Depot Id associated with this session.
InstallationPackageQuery	getInstallationPackageQuery()	Gets a package query.
InstallationPackageList	getInstallationPackagesByQuery(InstallationPackageQuery installationPackageQuery)	Gets a list of InstallationPackages matching the given package query.
void	useDenormalizedDependencyView()	A denormalized view returns all dependencies.
void	useDenormalizedVersionView()	All versions of the same package are returned.
void	useFederatedDepotView()	Federates the view for methods in this session.
void	useIsolatedDepotView()	Isolates the view for methods in this session.
void	useNormalizedDependencyView()	A normalized view uses a single InstallationPackage to represent a set of package dependencies.
void	useNormalizedVersionView()	The returns from the lookup methods may omit multiple versions of the same package.

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

getInstallationPackageSearch

InstallationPackageSearch getInstallationPackageSearch()

Gets a package search.

Returns:

the package search

Compliance:

mandatory - This method must be implemented.

getInstallationPackageSearchOrder

InstallationPackageSearchOrder getInstallationPackageSearchOrder()

Gets a package search order. The InstallationPackageSearchOrder is supplied to a InstallationPackageSearch to specify the ordering of results.

Returns:

the package search order

Compliance:

mandatory - This method must be implemented.

getInstallationPackagesBySearch

InstallationPackageSearchResults getInstallationPackagesBySearch(InstallationPackageQuery installationPackageQuery,
 InstallationPackageSearch installationPackageSearch)
                                                          throws OperationFailedException,
PermissionDeniedException

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

Parameters:

installationPackageQuery - the package query

installationPackageSearch - the package search

Returns:

the returned search results

Throws:

NullArgumentException - installationPackageQuery or installationPackageSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - installationPackageSearch or installationPackageQuery is not of this service

Compliance:

mandatory - This method must be implemented.

getInstallationPackageQueryFromInspector

InstallationPackageQuery getInstallationPackageQueryFromInspector(InstallationPackageQueryInspector installationPackageQueryInspector)

Gets a package query from an inspector. The inspector is available from a InstallationPackageeSearchResults.

Parameters:

installationPackageQueryInspector - a package query inspector

Returns:

the package query

Throws:

NullArgumentException - installationPackageQueryInspector is null

UnsupportedException - installationPackageQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.