Interface PackageSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, PackageQuerySession

public interface PackageSearchSession
extends PackageQuerySession

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

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

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

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

Method Summary

Modifier and Type	Method	Description
PackageQuery	getPackageQueryFromInspector(PackageQueryInspector packageQueryInspector)	Gets a package query from an inspector.
PackageSearchResults	getPackagesBySearch(PackageQuery packageQuery, PackageSearch packageSearch)	Gets the search results matching the given search query using the given search.
PackageSearch	getPackageSearch()	Gets a package search.
PackageSearchOrder	getPackageSearchOrder()	Gets a package 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 PackageQuerySession

canSearchPackages, getDepot, getDepotId, getPackageQuery, getPackagesByQuery, useDenormalizedDependencyView, useDenormalizedVersionView, useFederatedDepotView, useIsolatedDepotView, useNormalizedDependencyView, useNormalizedVersionView

Modifier and Type	Method	Description
boolean	canSearchPackages()	Tests if this user can perform Package searches.
Depot	getDepot()	Gets the Depot associated with this session.
Id	getDepotId()	Gets the Depot Id associated with this session.
PackageQuery	getPackageQuery()	Gets a package query.
PackageList	getPackagesByQuery(PackageQuery packageQuery)	Gets a list of Packages 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 Package to represent a set of package dependencies.
void	useNormalizedVersionView()	The returns from the lookup methods may omit multiple versions of the same package.

Method Details

getPackageSearch

PackageSearch getPackageSearch()

Gets a package search.

Returns:

the package search

Compliance:

mandatory - This method must be implemented.

getPackageSearchOrder

PackageSearchOrder getPackageSearchOrder()

Gets a package search order. The PackageSearchOrder is supplied to a PackageSearch to specify the ordering of results.

Returns:

the package search order

Compliance:

mandatory - This method must be implemented.

getPackagesBySearch

PackageSearchResults getPackagesBySearch(PackageQuery packageQuery,
 PackageSearch packageSearch)
                                  throws OperationFailedException,
PermissionDeniedException

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

Parameters:

packageQuery - the package query

packageSearch - the package search

Returns:

the returned search results

Throws:

NullArgumentException - packageQuery or packageSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - packageSearch or packageQuery is not of this service

Compliance:

mandatory - This method must be implemented.

getPackageQueryFromInspector

PackageQuery getPackageQueryFromInspector(PackageQueryInspector packageQueryInspector)

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

Parameters:

packageQueryInspector - a package query inspector

Returns:

the package query

Throws:

NullArgumentException - packageQueryInspector is null

UnsupportedException - packageQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.