Interface InstallationManagementSession
- All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
This session defines methods to manage installations.
-
Method Summary
Modifier and TypeMethodDescriptionbooleanTests if this user can manage installations A return of true does not guarantee successful authorization.getSite()Gets theSiteassociated with this session.Gets theSiteIdassociated with this session.installPackage(Id packageId) Installs a package at a default site.voidremoveInstallation(Id installationId) Removes an installation.voidRemoves all installations at the site.Methods inherited from interface OsidSession
closeMethods inherited from interface OsidSession
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactionsModifier and TypeMethodDescriptionGets the agent authenticated to this session.Gets theIdof the agent authenticated to this session.Gets the rate of the service clock.getDate()Gets the service date which may be the current date or the effective date in which this session exists.Gets the effective agent in use by this session.Gets theIdof the effective agent in use by this session.Gets theDisplayTextformatTypepreference in effect for this session.Gets the locale indicating the localization preferences in effect for this session.booleanTests if an agent is authenticated to this session.Starts a new transaction for this sesson.booleanTests for the availability of transactions.
-
Method Details
-
getSiteId
Id getSiteId()Gets theSiteIdassociated with this session.- Returns:
- the
Site Idassociated with this session - Compliance:
mandatory- This method must be implemented.
-
getSite
Gets theSiteassociated with this session.- Returns:
- the
Siteassociated with this session - Throws:
OperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
canManageInstallations
boolean canManageInstallations()Tests if this user can manage installations 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 aPERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer management operations to unauthorized users.- Returns:
falseifPackageinstallation is not authorized,trueotherwise- Compliance:
mandatory- This method must be implemented.
-
installPackage
Installation installPackage(Id packageId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException Installs a package at a default site.- Parameters:
packageId- anIdof aPackage- Returns:
- the resulting
Installation - Throws:
AlreadyExistsException- package is already installedNotFoundException-packageIdis not foundNullArgumentException-packageIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
removeInstallation
void removeInstallation(Id installationId) throws NotFoundException, OperationFailedException, PermissionDeniedException Removes an installation.- Parameters:
installationId- anIdof anInstallation- Throws:
NotFoundException-installationIdis not foundNullArgumentException-installationIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
removeInstallations
Removes all installations at the site.- Throws:
OperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-