public interface PackageQuerySession extends OsidSession
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.
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 |
---|---|
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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getDepotId()
Depot
Id
associated with this
session. Depot Id
associated with this sessionmandatory
- This method must be implemented. Depot getDepot() throws OperationFailedException, PermissionDeniedException
Depot
associated with this session. Depot
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchPackages()
Package
searches. A
return of true does not guarantee successful authorization. A return
of false indicates that it is known all methods in this session will
result in a PERMISSION_DENIED.
This is intended as a
hint to an application that may opt not to offer search operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedDepotView()
mandatory
- This method is must be implemented. void useIsolatedDepotView()
mandatory
- This method is must be implemented. void useNormalizedVersionView()
mandatory
- This method is must be implemented. void useDenormalizedVersionView()
mandatory
- This method is must be implemented. void useNormalizedDependencyView()
Package
to represent a
set of package dependencies.mandatory
- This method is must be implemented. void useDenormalizedDependencyView()
mandatory
- This method is must be implemented. PackageQuery getPackageQuery()
mandatory
- This method must be implemented. PackageList getPackagesByQuery(PackageQuery packageQuery) throws OperationFailedException, PermissionDeniedException
Packages
matching the given package
query.packageQuery
- the package query PackageList
NullArgumentException
- packageQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- packageQuery
is
not of this servicemandatory
- This method must be implemented.