Interface | osid.recognition.ConferralForm | ||
---|---|---|---|
Implements | osid.OsidRelationshipForm | ||
Description |
This is the form for creating and updating | ||
Method | getReferenceMetadata | ||
Description |
Gets the metadata for the reference. | ||
Return | osid.Metadata | metadata for the reference | |
Compliance | mandatory | This method must be implemented. | |
Method | setReference | ||
Description |
Sets the date conferred. | ||
Parameters | osid.id.Id | referenceId | the reference |
Errors | INVALID_ARGUMENT | referenceId is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | referenceId is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearReference | ||
Description |
Clears the reference. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getConvocationMetadata | ||
Description |
Gets the metadata for the convocation. | ||
Return | osid.Metadata | metadata for the convocation | |
Compliance | mandatory | This method must be implemented. | |
Method | setConvocation | ||
Description |
Sets the convocation. | ||
Parameters | osid.id.Id | convocationId | the convocation Id |
Errors | INVALID_ARGUMENT | convocationId is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | convocationId is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearConvocation | ||
Description |
Clears the convocation. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getConferralFormRecord | ||
Description |
Gets the | ||
Parameters | osid.type.Type | conferralRecordType | the conferral record type |
Return | osid.recognition.records.ConferralFormRecord | the conferral form record | |
Errors | NULL_ARGUMENT | conferralRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(conferralRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |