Interface Package

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject, Sourceable
public interface Package extends OsidObject, Sourceable

A Package represents an installation bundle in a depot.

  • Method Details

    • getVersion

      Version getVersion()
      Gets the version of this package.
      Returns:
      the package version
      Compliance:
      mandatory - This method must be implemented.

    • getCopyright

      DisplayText getCopyright()
      Gets the copyright of this package.
      Returns:
      the copyright
      Compliance:
      mandatory - This method must be implemented.

    • requestsLicenseAcknowledgement

      boolean requestsLicenseAcknowledgement()
      Tests if the provider requests acknowledgement of the license.
      Returns:
      true if the consumer should acknowledge the terms in the license, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCreatorId

      Id getCreatorId()
      Gets the creator or author of this package.
      Returns:
      the creator Id
      Compliance:
      mandatory - This method must be implemented.

    • getCreator

      Resource getCreator() throws OperationFailedException
      Gets the creator Id of this package.
      Returns:
      the creator
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getReleaseDate

      DateTime getReleaseDate()
      Gets the release date of this package.
      Returns:
      the timestamp of this package
      Compliance:
      mandatory - This method must be implemented.

    • getDependencyIds

      IdList getDependencyIds()
      Gets the package Ids on which this package directly depends.
      Returns:
      the package dependency Ids
      Compliance:
      mandatory - This method must be implemented.

    • getDependencies

      PackageList getDependencies() throws OperationFailedException
      Gets the packages on which this package directly depends.
      Returns:
      the package dependencies
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getURL

      String getURL()
      Gets a url for this package. The url may point to an external project or product site. If no url is available an empty string is returned.
      Returns:
      the url for this package
      Compliance:
      mandatory - This method must be implemented.

    • getInstallationContentIds

      IdList getInstallationContentIds() throws OperationFailedException
      Gets the installation content Ids .
      Returns:
      the installation content Ids
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getInstallationContents

      InstallationContentList getInstallationContents() throws OperationFailedException
      Gets the installation contents.
      Returns:
      the installation contents
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getPackageRecord

      PackageRecord getPackageRecord(Type packageRecordType) throws OperationFailedException
      Gets the package record corresponding to the given Package record Type .This method is used to retrieve an object implementing the requested record. The packageRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(packageRecordType) is true .
      Parameters:
      packageRecordType - the type of the record to retrieve
      Returns:
      the package record
      Throws:
      NullArgumentException - packageRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(packageRecordType) is false
      Compliance:
      mandatory - This method must be implemented.