public interface InstallationQuerySession extends OsidSession
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.
Installations may have a query record indicated by their respective
record types. The query record is accessed via the
InstallationQuery.
Modifier and Type | Method and 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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getSiteId()
Site
Id
associated with this
session. Site Id
associated with this sessionmandatory
- This method must be implemented. Site getSite() throws OperationFailedException, PermissionDeniedException
Site
associated with this session. Site
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchInstallations()
Installation
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 useNormalizedVersionView()
mandatory
- This method is must be implemented. void useDenormalizedVersionView()
mandatory
- This method is must be implemented. void useNormalizedDependencyView()
Installation
to
represent a set of package dependencies.mandatory
- This method is must be implemented. void useDenormalizedDependencyView()
mandatory
- This method is must be implemented. InstallationQuery getInstallationQuery()
mandatory
- This method must be implemented. InstallationList getInstallationsByQuery(InstallationQuery installationQuery) throws OperationFailedException, PermissionDeniedException
Installations
matching the given
installation query.installationQuery
- the installation query InstallationList
NullArgumentException
- installationQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- installationQuery
is not of this servicemandatory
- This method must be implemented.