OSID Specifications
osid package
Version 3.0.0
Release Candidate Preview
osid package
Version 3.0.0
Release Candidate Preview
| Interface | osid.OsidCompendiumForm | ||
|---|---|---|---|
| Implements | osid.OsidObjectForm | ||
osid.OsidSubjugateableForm | |||
| Description |
This form is used to create and update governators. | ||
| Method | getStartDateMetadata | ||
| Description |
Gets the metadata for a start date. | ||
| Return | osid.Metadata | metadata for the date | |
| Compliance | mandatory | This method must be implemented. | |
| Method | setStartDate | ||
| Description |
Sets the start date. | ||
| Parameters | osid.calendaring.DateTime | date | the new date |
| Errors | INVALID_ARGUMENT | date is invalid | |
| NO_ACCESS | Metadata.isReadOnly() is true | ||
| NULL_ARGUMENT | date is null | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | clearStartDate | ||
| Description |
Clears the start date. | ||
| Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEndDateMetadata | ||
| Description |
Gets the metadata for an end date. | ||
| Return | osid.Metadata | metadata for the date | |
| Compliance | mandatory | This method must be implemented. | |
| Method | setEndDate | ||
| Description |
Sets the end date. | ||
| Parameters | osid.calendaring.DateTime | date | the new date |
| Errors | INVALID_ARGUMENT | date is invalid | |
| NO_ACCESS | Metadata.isReadOnly() is true | ||
| NULL_ARGUMENT | date is null | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | clearEndDate | ||
| Description |
Clears the end date. | ||
| Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInterpolatedMetadata | ||
| Description |
Gets the metadata for the interpolated flag. | ||
| Return | osid.Metadata | metadata for the interpolated flag | |
| Compliance | mandatory | This method must be implemented. | |
| Method | setInterpolated | ||
| Description |
Sets the interpolated flag. | ||
| Parameters | boolean | interpolated | the new interpolated flag |
| Errors | INVALID_ARGUMENT | interpolated is invalid | |
| NO_ACCESS | Metadata.isReadOnly() is true | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | clearInterpolated | ||
| Description |
Clears the interpolated flag. | ||
| Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getExtrapolatedMetadata | ||
| Description |
Gets the metadata for the extrapolated flag. | ||
| Return | osid.Metadata | metadata for the extrapolated flag | |
| Compliance | mandatory | This method must be implemented. | |
| Method | setExtrapolated | ||
| Description |
Sets the extrapolated flag. | ||
| Parameters | boolean | extrapolated | the new extrapolated flag |
| Errors | INVALID_ARGUMENT | extrapolated is invalid | |
| NO_ACCESS | Metadata.isReadOnly() is true | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | clearExtrapolated | ||
| Description |
Clears the extrapolated flag. | ||
| Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
| Compliance | mandatory | This method must be implemented. | |