OSID Specifications
osid package
Version 3.0.0
Release Candidate Preview
osid package
Version 3.0.0
Release Candidate Preview
| Interface | osid.OsidOperableForm | ||
|---|---|---|---|
| Implements | osid.OsidForm | ||
| Description |
This form is used to create and update operables. | ||
| Method | getEnabledMetadata | ||
| Description |
Gets the metadata for the enabled flag. | ||
| Return | osid.Metadata | metadata for the enabled flag | |
| Compliance | mandatory | This method must be implemented. | |
| Method | setEnabled | ||
| Description |
Sets the administratively enabled flag. | ||
| Parameters | boolean | enabled | the new enabled flag |
| Errors | INVALID_ARGUMENT | enabled is invalid | |
| NO_ACCESS | Metadata.isReadOnly() is true | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | clearEnabled | ||
| Description |
Removes the administratively enabled flag. | ||
| Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDisabledMetadata | ||
| Description |
Gets the metadata for the disabled flag. | ||
| Return | osid.Metadata | metadata for the disabled flag | |
| Compliance | mandatory | This method must be implemented. | |
| Method | setDisabled | ||
| Description |
Sets the administratively disabled flag. | ||
| Parameters | boolean | disabled | the new disabled flag |
| Errors | INVALID_ARGUMENT | disabled is invalid | |
| NO_ACCESS | Metadata.isReadOnly() is true | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | clearDisabled | ||
| Description |
Removes the administratively disabled flag. | ||
| Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
| Compliance | mandatory | This method must be implemented. | |