OSID Specifications
type package
Version 3.0.0
Release Candidate Preview
type package
Version 3.0.0
Release Candidate Preview
| Interface | osid.type.TypeForm | ||
|---|---|---|---|
| Implements | osid.OsidForm | ||
| Description |
This form provides a means of updating various fields in
the | ||
| Method | getDisplayNameMetadata | ||
| Description |
Gets the metadata for the display name. | ||
| Return | osid.Metadata | metadata for the display name | |
| Compliance | mandatory | This method must be implemented. | |
| Method | setDisplayName | ||
| Description |
Sets a display name. | ||
| Parameters | string | displayName | the new display name |
| Errors | INVALID_ARGUMENT | displayName is invalid | |
| NO_ACCESS | displayName cannot be modified | ||
| NULL_ARGUMENT | displayName is null | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | clearDisplayName | ||
| Description |
Clears the display name. | ||
| Errors | NO_ACCESS | displayName cannot be modified | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDisplayLabelMetadata | ||
| Description |
Gets the metadata for the display label. | ||
| Return | osid.Metadata | metadata for the display label | |
| Compliance | mandatory | This method must be implemented. | |
| Method | setDisplayLabel | ||
| Description |
Seta a display label. | ||
| Parameters | string | displayLabel | the new display label |
| Errors | INVALID_ARGUMENT | displayLabel is invalid | |
| NO_ACCESS | displayLabel cannot be modified | ||
| NULL_ARGUMENT | displayLabel is null | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | clearDisplayLabel | ||
| Description |
Clears the display label. | ||
| Errors | NO_ACCESS | displayLabel cannot be modified | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescriptionMetadata | ||
| Description |
Gets the metadata for the description. | ||
| Return | osid.Metadata | metadata for the description | |
| Compliance | mandatory | This method must be implemented. | |
| Method | setDescription | ||
| Description |
Sets a description. | ||
| Parameters | string | description | the new description |
| Errors | INVALID_ARGUMENT | description is invalid | |
| NO_ACCESS | description cannot be modified | ||
| NULL_ARGUMENT | description is null | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | clearDescription | ||
| Description |
Clears the description. | ||
| Errors | NO_ACCESS | description cannot be modified | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDomainMetadata | ||
| Description |
Gets the metadata for the domain. | ||
| Return | osid.Metadata | metadata for the domain | |
| Compliance | mandatory | This method must be implemented. | |
| Method | setDomain | ||
| Description |
Sets a domain. | ||
| Parameters | string | domain | the new domain |
| Errors | INVALID_ARGUMENT | domain is invalid | |
| NO_ACCESS | domain cannot be modified | ||
| NULL_ARGUMENT | domain is null | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | clearDomain | ||
| Description |
Clears the domain. | ||
| Errors | NO_ACCESS | domain cannot be modified | |
| Compliance | mandatory | This method must be implemented. | |