public interface InstallationManagementSession extends OsidSession
This session defines methods to manage installations.
Modifier and Type | Method and Description |
---|---|
boolean |
canManageInstallations()
Tests if this user can manage installations A return of true does not
guarantee successful authorization.
|
Site |
getSite()
Gets the
Site associated with this session. |
Id |
getSiteId()
Gets the
Site Id associated with this
session. |
Installation |
installPackage(Id packageId)
Installs a package at a default site.
|
void |
removeInstallation(Id installationId)
Removes an installation.
|
void |
removeInstallations()
Removes all installations at the site.
|
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 canManageInstallations()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer management operations to
unauthorized users. false
if Package
installation is
not authorized, true
otherwisemandatory
- This method must be implemented. Installation installPackage(Id packageId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
packageId
- an Id
of a Package
Installation
AlreadyExistsException
- package is already installedNotFoundException
- packageId
is not
foundNullArgumentException
- packageId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeInstallation(Id installationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
installationId
- an Id
of an Installation
NotFoundException
- installationId
is
not foundNullArgumentException
- installationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeInstallations() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.