Interface | osid.installation.PackageForm | ||
---|---|---|---|
Implements | osid.OsidObjectForm | ||
osid.OsidSourceableForm | |||
Description |
This is the form for creating and updating | ||
Method | getVersionMetadata | ||
Description |
Gets the metadata for a version. | ||
Return | osid.Metadata | metadata for the version | |
Compliance | mandatory | This method must be implemented. | |
Method | setVersion | ||
Description |
Sets the version. | ||
Parameters | osid.installation.Version | version | the new version |
Errors | INVALID_ARGUMENT | version is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | version is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearVersion | ||
Description |
Clears the version. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getCopyrightMetadata | ||
Description |
Gets the metadata for a copyright. | ||
Return | osid.Metadata | metadata for the copyright | |
Compliance | mandatory | This method must be implemented. | |
Method | setCopyright | ||
Description |
Sets the copyright. | ||
Parameters | string | copyright | the new copyright |
Errors | INVALID_ARGUMENT | copyright is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | copyright is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearCopyright | ||
Description |
Clears the version. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getRequiresLicenseAcknowledgementMetadata | ||
Description |
Gets the metadata for the requires license acknowledgement flag. | ||
Return | osid.Metadata | metadata for the acknowledgement flag | |
Compliance | mandatory | This method must be implemented. | |
Method | setRequiresLicenseAcknowledgement | ||
Description |
Sets the requires license acknowledgement flag. | ||
Parameters | boolean | requiresLicenseAcknowledgement | the new ackknowledgement flag |
Errors | INVALID_ARGUMENT | requiresLicenseAcknowledgement is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearRequiresLicenseAcknowledgement | ||
Description |
Clears the acknowledgement flag. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getCreatorMetadata | ||
Description |
Gets the metadata for a creator resource. | ||
Return | osid.Metadata | metadata for the creator resource | |
Compliance | mandatory | This method must be implemented. | |
Method | setCreator | ||
Description |
Sets the creator resource. | ||
Parameters | osid.id.Id | resourceId | the new creator resource |
Errors | INVALID_ARGUMENT | resourceId is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | resourceId is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearCreator | ||
Description |
Clears the creator. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getReleaseDateMetadata | ||
Description |
Gets the metadata for the release date. | ||
Return | osid.Metadata | metadata for the release date | |
Compliance | mandatory | This method must be implemented. | |
Method | setReleaseDate | ||
Description |
Sets the publisher release date. | ||
Parameters | osid.calendaring.DateTime | releaseDate | the new release date |
Errors | INVALID_ARGUMENT | releaseDate is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | releaseDate is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearReleaseDate | ||
Description |
Clears the release date. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getDependenciesMetadata | ||
Description |
Gets the metadata for the package dependencies. | ||
Return | osid.Metadata | metadata for the package dependencies | |
Compliance | mandatory | This method must be implemented. | |
Method | setDependencies | ||
Description |
Sets the dependencies. | ||
Parameters | osid.id.Id[] | packageIds | the new package dependencies |
Errors | INVALID_ARGUMENT | packageIds is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | packageIds is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearDependencies | ||
Description |
Clears the package dependencies. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getURLMetadata | ||
Description |
Gets the metadata for the url. | ||
Return | osid.Metadata | metadata for the url | |
Compliance | mandatory | This method must be implemented. | |
Method | setURL | ||
Description |
Sets the url. | ||
Parameters | string | url | the new url |
Errors | INVALID_ARGUMENT | url is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | url is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearURL | ||
Description |
Clears the url. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getPackageFormRecord | ||
Description |
Gets the | ||
Parameters | osid.type.Type | packageRecordType | the package record type |
Return | osid.installation.records.PackageFormRecord | the package form record | |
Errors | NULL_ARGUMENT | packageRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(packageRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |