Interface InstallationContent

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject, Subjugateable
public interface InstallationContent extends OsidObject, Subjugateable

An installation content contains information about the installation data.

  • Method Details

    • getPackageId

      Id getPackageId()
      Gets the Package Id corresponding to this content.
      Returns:
      the package Id
      Compliance:
      mandatory - This method must be implemented.

    • getPackage

      Package getPackage()
      Gets the Package corresponding to this content.
      Returns:
      the package
      Compliance:
      mandatory - This method must be implemented.

    • hasDataLength

      boolean hasDataLength()
      Tests if a data length is available.
      Returns:
      true if a length is available for this content, false otherwise.
      Compliance:
      mandatory - This method must be implemented.

    • getDataLength

      long getDataLength()
      Gets the length of the data represented by this content in bytes.
      Returns:
      the length of the data stream
      Throws:
      IllegalStateException - hasDataLength() is false
      Compliance:
      mandatory - This method must be implemented.

    • getData

      DataInputStream getData() throws OperationFailedException
      Gets the asset content data.
      Returns:
      the length of the content data
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getInstallationContentRecord

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