public interface InstallationLookupSession extends OsidSession
The session defines methods for retrieving Installations
from installation Sites.
An Installation
represents a Package
installed on a Site.
Two views are defined in this session:
Installations may have an additional records indicated by their
respective record types. The record may not be accessed through a cast of
the Installation.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupInstallations()
Tests if this user can perform
Installation lookups. |
Installation |
getInstallation(Id installationId)
Gets the
Installation specified by its Id. |
InstallationList |
getInstallations()
Gets all
Installations. |
InstallationList |
getInstallationsByGenusType(Type installationGenusType)
Gets an
InstallationList corresponding to the given
installation genus Type which does not include
installations of genus types derived from the specified Type. |
InstallationList |
getInstallationsByIds(IdList installationIds)
Gets an
InstallationList corresponding to the given
IdList. |
InstallationList |
getInstallationsByPackage(Id packageId)
Gets an
InstallationList corresponding to the given
Package. |
InstallationList |
getInstallationsByParentGenusType(Type installationGenusType)
Gets an
InstallationList corresponding to the given
installation genus Type and include any additional
installations with genus types derived from the specified Type. |
InstallationList |
getInstallationsByRecordType(Type installationRecordType)
Gets an
InstallationList containing the given
installation record Type. |
Site |
getSite()
Gets the
Site associated with this session. |
Id |
getSiteId()
Gets the
Site Id associated with this
session. |
void |
useComparativeInstallationView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useDenormalizedVersionView()
All versions of the same installation are returned.
|
void |
useNormalizedVersionView()
The returns from the lookup methods may omit multiple versions of the
same installation.
|
void |
usePlenaryInstallationView()
A complete view of the
Installation returns is desired. |
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 canLookupInstallations()
Installation
lookups. 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 lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeInstallationView()
mandatory
- This method is must be implemented. void usePlenaryInstallationView()
Installation
returns is desired.
Methods will return what is requested or result in an error. This view
is used when greater precision is desired at the expense of
interoperability.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. Installation getInstallation(Id installationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Installation
specified by its Id.
In plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned
Installation
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to an Installation
and retained for
compatibility.installationId
- Id
of the Installation
NotFoundException
- installationId
not
foundNullArgumentException
- installationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. InstallationList getInstallationsByIds(IdList installationIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
InstallationList
corresponding to the given
IdList.
In plenary mode, the returned list contains all
of the installations specified in the Id
list, in the
order of the list, including duplicates, or an error results if an
Id
in the supplied list is not found or inaccessible.
Otherwise, inaccessible Installations
may be omitted
from the list and may present the elements in any order including
returning a unique set.installationIds
- the list of Ids
to retrieve Installation
listNotFoundException
- an Id
was not foundNullArgumentException
- installationIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InstallationList getInstallationsByGenusType(Type installationGenusType) throws OperationFailedException, PermissionDeniedException
InstallationList
corresponding to the given
installation genus Type
which does not include
installations of genus types derived from the specified Type.
In plenary mode, the returned list contains all known
installations or an error results. Otherwise, the returned list may
contain only those installations that are accessible through this
session.installationGenusType
- an installation genus type Installation
listNullArgumentException
- installationGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InstallationList getInstallationsByParentGenusType(Type installationGenusType) throws OperationFailedException, PermissionDeniedException
InstallationList
corresponding to the given
installation genus Type
and include any additional
installations with genus types derived from the specified Type.
In plenary mode, the returned list contains all known
installations or an error results. Otherwise, the returned list may
contain only those installations that are accessible through this
session.installationGenusType
- an installation genus type Installation
listNullArgumentException
- installationGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InstallationList getInstallationsByRecordType(Type installationRecordType) throws OperationFailedException, PermissionDeniedException
InstallationList
containing the given
installation record Type.
In plenary mode, the returned
list contains all known installations or an error results. Otherwise,
the returned list may contain only those installations that are
accessible through this session.installationRecordType
- an installation record type Installation
listNullArgumentException
- installationGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InstallationList getInstallationsByPackage(Id packageId) throws OperationFailedException, PermissionDeniedException
InstallationList
corresponding to the given
Package.
In plenary mode, the returned list contains
all of the installations for the specified package, in the order of
the list, including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible Installations
may be omitted from the list
and may present the elements in any order including returning a unique
set.packageId
- Id
of a Package
Installation
listNullArgumentException
- packageId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InstallationList getInstallations() throws OperationFailedException, PermissionDeniedException
Installations.
In plenary mode, the returned
list contains all known installations or an error results. Otherwise,
the returned list may contain only those installations that are
accessible through this session. In both cases, the order of the set
is not specified. InstallationList
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.