Interface | osid.OsidObjectForm | ||
---|---|---|---|
Implements | osid.OsidIdentifiableForm | ||
osid.OsidExtensibleForm | |||
osid.OsidBrowsableForm | |||
Description |
The Generally, a set method parallels each get method of an
The form may provide some feedback as to the validity of certain data updates before the update transaction is issued to the correspodning session but a successful modification of the form is not a guarantee of success for the update transaction. A consumer may elect to perform all updates within a single update transaction or break up a large update intio smaller units. The tradeoff is the granularity of error feedback vs. the performance gain of a single transaction. As with all aspects of the OSIDs, nulls cannot be used. Methods to clear values are also defined in the form. A new ObjectForm form = session.getObjectFormForUpdate(objectId); form.setDisplayName("new name"); ColorForm recordForm = form.getFormRecord(colorRecordType); recordForm.setColor("green"); session.updateObject(objectId, form); | ||
Method | getDisplayNameMetadata | ||
Description |
Gets the metadata for a display name. | ||
Return | osid.Metadata | metadata for the display name | |
Compliance | mandatory | This method must be implemented. | |
Method | setDisplayName | ||
Description |
Sets a display name. A display name is required and if not set, will be set by the provider. | ||
Parameters | string | displayName | the new display name |
Errors | INVALID_ARGUMENT | displayName is invalid | |
NO_ACCESS | Metadata.isReadonly() is true | ||
NULL_ARGUMENT | displayName is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearDisplayName | ||
Description |
Clears the display name. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getDescriptionMetadata | ||
Description |
Gets the metadata for a 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 | Metadata.isReadonly() is true | ||
NULL_ARGUMENT | description is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearDescription | ||
Description |
Clears the description. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getGenusTypeMetadata | ||
Description |
Gets the metadata for a genus type. | ||
Return | osid.Metadata | metadata for the genus | |
Compliance | mandatory | This method must be implemented. | |
Method | setGenusType | ||
Description |
Sets a genus. A genus cannot be cleared because all objects have at minimum a root genus. | ||
Parameters | osid.type.Type | genusType | the new genus |
Errors | INVALID_ARGUMENT | genusType is invalid | |
NO_ACCESS | Metadata.isReadonly() is true | ||
NULL_ARGUMENT | genusType is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearGenusType | ||
Description |
Clears the genus type. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. |