OSID Logo
OSID Specifications
installation package
Version 3.0.0
Release Candidate Preview
Interfaceosid.installation.PackageForm
Implementsosid.OsidObjectForm
osid.OsidSourceableForm
Description

This is the form for creating and updating Packages. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the PackageAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetVersionMetadata
Description

Gets the metadata for a version.

Returnosid.Metadatametadata for the version
CompliancemandatoryThis method must be implemented.
MethodsetVersion
Description

Sets the version.

Parametersosid.installation.Versionversionthe new version
ErrorsINVALID_ARGUMENT version is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT version is null
CompliancemandatoryThis method must be implemented.
MethodclearVersion
Description

Clears the version.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetCopyrightMetadata
Description

Gets the metadata for a copyright.

Returnosid.Metadatametadata for the copyright
CompliancemandatoryThis method must be implemented.
MethodsetCopyright
Description

Sets the copyright.

Parametersstringcopyrightthe new copyright
ErrorsINVALID_ARGUMENT copyright is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT copyright is null
CompliancemandatoryThis method must be implemented.
MethodclearCopyright
Description

Clears the version.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetRequiresLicenseAcknowledgementMetadata
Description

Gets the metadata for the requires license acknowledgement flag.

Returnosid.Metadatametadata for the acknowledgement flag
CompliancemandatoryThis method must be implemented.
MethodsetRequiresLicenseAcknowledgement
Description

Sets the requires license acknowledgement flag.

ParametersbooleanrequiresLicenseAcknowledgementthe new ackknowledgement flag
ErrorsINVALID_ARGUMENT requiresLicenseAcknowledgement is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearRequiresLicenseAcknowledgement
Description

Clears the acknowledgement flag.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetCreatorMetadata
Description

Gets the metadata for a creator resource.

Returnosid.Metadatametadata for the creator resource
CompliancemandatoryThis method must be implemented.
MethodsetCreator
Description

Sets the creator resource.

Parametersosid.id.IdresourceIdthe new creator resource
ErrorsINVALID_ARGUMENT resourceId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearCreator
Description

Clears the creator.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetReleaseDateMetadata
Description

Gets the metadata for the release date.

Returnosid.Metadatametadata for the release date
CompliancemandatoryThis method must be implemented.
MethodsetReleaseDate
Description

Sets the publisher release date.

Parametersosid.calendaring.DateTimereleaseDatethe new release date
ErrorsINVALID_ARGUMENT releaseDate is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT releaseDate is null
CompliancemandatoryThis method must be implemented.
MethodclearReleaseDate
Description

Clears the release date.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetDependenciesMetadata
Description

Gets the metadata for the package dependencies.

Returnosid.Metadatametadata for the package dependencies
CompliancemandatoryThis method must be implemented.
MethodsetDependencies
Description

Sets the dependencies.

Parametersosid.id.Id[]packageIdsthe new package dependencies
ErrorsINVALID_ARGUMENT packageIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT packageIds is null
CompliancemandatoryThis method must be implemented.
MethodclearDependencies
Description

Clears the package dependencies.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetURLMetadata
Description

Gets the metadata for the url.

Returnosid.Metadatametadata for the url
CompliancemandatoryThis method must be implemented.
MethodsetURL
Description

Sets the url.

Parametersstringurlthe new url
ErrorsINVALID_ARGUMENT url is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT url is null
CompliancemandatoryThis method must be implemented.
MethodclearURL
Description

Clears the url.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetPackageFormRecord
Description

Gets the PackageFormRecord corresponding to the given package record Type.

Parametersosid.type.TypepackageRecordTypethe package record type
Returnosid.installation.records.PackageFormRecordthe package form record
ErrorsNULL_ARGUMENT packageRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(packageRecordType) is false
CompliancemandatoryThis method must be implemented.