Interface Installation

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject
public interface Installation extends OsidObject

A Installation represents a Package installed on a Site .

  • Method Details

    • getSiteId

      Id getSiteId()
      Gets the Site Id in which this installation is installed.
      Returns:
      the site Id
      Compliance:
      mandatory - This method must be implemented.

    • getSite

      Site getSite() throws OperationFailedException
      Gets the Site in which this installation is installed.
      Returns:
      the package site
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getPackageId

      Id getPackageId()
      Gets the package Id of this installation.
      Returns:
      the package Id
      Compliance:
      mandatory - This method must be implemented.

    • getPackage

      Package getPackage() throws OperationFailedException
      Gets the package.
      Returns:
      the package
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getDepotId

      Id getDepotId()
      Gets the Id of depot from which the package was installed.
      Returns:
      the depot Id
      Compliance:
      mandatory - This method must be implemented.

    • getDepot

      Depot getDepot() throws OperationFailedException
      Gets the depot from which the package was installed.
      Returns:
      the depot
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getInstallDate

      DateTime getInstallDate()
      Gets the date the package was installed.
      Returns:
      the installation date
      Compliance:
      mandatory - This method must be implemented.

    • getAgentId

      Id getAgentId()
      Gets the Id of the agent who installed this package.
      Returns:
      the agent Id
      Compliance:
      mandatory - This method must be implemented.

    • getAgent

      Agent getAgent() throws OperationFailedException
      Gets the agent who installed this package.
      Returns:
      the agent
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getLastCheckDate

      DateTime getLastCheckDate()
      Gets the date the installation was last checked for updates.
      Returns:
      the last check date
      Compliance:
      mandatory - This method must be implemented.

    • getInstallationRecord

      InstallationRecord getInstallationRecord(Type installationRecordType) throws OperationFailedException
      Gets the installation record corresponding to the given 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 .
      Parameters:
      installationRecordType - the type of the record to retrieve
      Returns:
      the installation record
      Throws:
      NullArgumentException - installationRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(installationRecordType) is false
      Compliance:
      mandatory - This method must be implemented.