public interface PackageSearchSession extends PackageQuerySession
This session provides methods for searching Package
objects. 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.
Packages may have a query record indicated by their respective record
types. The query record is accessed via the PackageQuery.
Modifier and Type | Method and 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.
|
canSearchPackages, getDepot, getDepotId, getPackageQuery, getPackagesByQuery, useDenormalizedDependencyView, useDenormalizedVersionView, useFederatedDepotView, useIsolatedDepotView, useNormalizedDependencyView, useNormalizedVersionView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
PackageSearch getPackageSearch()
mandatory
- This method must be implemented. PackageSearchOrder getPackageSearchOrder()
PackageSearchOrder
is
supplied to a PackageSearch
to specify the ordering of
results.mandatory
- This method must be implemented. PackageSearchResults getPackagesBySearch(PackageQuery packageQuery, PackageSearch packageSearch) throws OperationFailedException, PermissionDeniedException
packageQuery
- the package querypackageSearch
- the package searchNullArgumentException
- packageQuery
or
packageSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- packageSearch
or
packageQuery
is not of this servicemandatory
- This method must be implemented. PackageQuery getPackageQueryFromInspector(PackageQueryInspector packageQueryInspector)
PackageeSearchResults.
packageQueryInspector
- a package query inspectorNullArgumentException
- packageQueryInspector
is null
UnsupportedException
- packageQueryInspector
is not of this servicemandatory
- This method must be implemented.