public interface Installation extends OsidObject
A Installation
represents a Package
installed on a Site.
Modifier and Type | Method and Description |
---|---|
Agent |
getAgent()
Gets the agent who installed this package.
|
Id |
getAgentId()
Gets the
Id of the agent who installed this package. |
Depot |
getDepot()
Gets the depot from which the package was installed.
|
Id |
getDepotId()
Gets the
Id of depot from which the package was
installed. |
InstallationRecord |
getInstallationRecord(Type installationRecordType)
Gets the installation record corresponding to the given
Installation record Type. |
DateTime |
getInstallDate()
Gets the date the package was installed.
|
DateTime |
getLastCheckDate()
Gets the date the installation was last checked for updates.
|
Package |
getPackage()
Gets the package.
|
Id |
getPackageId()
Gets the package
Id of this installation. |
Site |
getSite()
Gets the
Site in which this installation is installed. |
Id |
getSiteId()
Gets the
Site Id in which this installation is
installed. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
Id getSiteId()
Site Id
in which this installation is
installed. Id
mandatory
- This method must be implemented. Site getSite() throws OperationFailedException
Site
in which this installation is installed.OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getPackageId()
Id
of this installation. Id
mandatory
- This method must be implemented. Package getPackage() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getDepotId()
Id
of depot from which the package was
installed. Id
mandatory
- This method must be implemented. Depot getDepot() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. DateTime getInstallDate()
mandatory
- This method must be implemented. Id getAgentId()
Id
of the agent who installed this package. Id
mandatory
- This method must be implemented. Agent getAgent() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. DateTime getLastCheckDate()
mandatory
- This method must be implemented. InstallationRecord getInstallationRecord(Type installationRecordType) throws OperationFailedException
Installation
record Type.
This method is used
to retrieve an object implementing the requested record. The
installationRecordType
may be the Type
returned
in getRecordTypes()
or any of its parents in a
Type
hierarchy where
hasRecordType(installationRecordType)
is true
.installationRecordType
- the type of the record to retrieveNullArgumentException
- installationRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(installationRecordType)
is false
mandatory
- This method must be implemented.