Interface InstallationManagementSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface InstallationManagementSession
extends OsidSession

This session defines methods to manage installations.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getSiteId

Id getSiteId()

Gets the Site Id associated with this session.

Returns:

the Site Id associated with this session

Compliance:

mandatory - This method must be implemented.

getSite

Site getSite()
      throws OperationFailedException,
PermissionDeniedException

Gets the Site associated with this session.

Returns:

the Site associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - 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 a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer management operations to unauthorized users.

Returns:

false if Package installation is not authorized, true otherwise

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 - an Id of a Package

Returns:

the resulting Installation

Throws:

AlreadyExistsException - package is already installed

NotFoundException - packageId is not found

NullArgumentException - packageId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeInstallation

void removeInstallation(Id installationId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an installation.

Parameters:

installationId - an Id of an Installation

Throws:

NotFoundException - installationId is not found

NullArgumentException - installationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeInstallations

void removeInstallations()
                  throws OperationFailedException,
PermissionDeniedException

Removes all installations at the site.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.