Interface | osid.recognition.ConvocationForm | ||
---|---|---|---|
Implements | osid.OsidGovernatorForm | ||
Description |
This is the form for creating and updating | ||
Method | getAwardsMetadata | ||
Description |
Gets the metadata for the awards. | ||
Return | osid.Metadata | metadata for the awards | |
Compliance | mandatory | This method must be implemented. | |
Method | setAwards | ||
Description |
Sets the list of awards. | ||
Parameters | osid.id.Id[] | awardIds | a list of award Ids |
Errors | INVALID_ARGUMENT | awardIds is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | awardIds is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearAwards | ||
Description |
Clears the awards. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getDateMetadata | ||
Description |
Gets the metadata for the date. | ||
Return | osid.Metadata | metadata for the date | |
Compliance | mandatory | This method must be implemented. | |
Method | setDate | ||
Description |
Sets the date. | ||
Parameters | osid.calendaring.DateTime | date | a 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 | clearDate | ||
Description |
Clears the date. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getTimePeriodMetadata | ||
Description |
Gets the metadata for the time period. | ||
Return | osid.Metadata | metadata for the time period | |
Compliance | mandatory | This method must be implemented. | |
Method | setTimePeriod | ||
Description |
Sets the time period. | ||
Parameters | osid.id.Id | timePeriodId | the time period Id |
Errors | INVALID_ARGUMENT | timePeriodId is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | timePeriodId is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearTimePeriod | ||
Description |
Clears the time period. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getConvocationFormRecord | ||
Description |
Gets the | ||
Parameters | osid.type.Type | convocationRecordType | the convocation record type |
Return | osid.recognition.records.ConvocationFormRecord | the convocation form record | |
Errors | NULL_ARGUMENT | convocationRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(convocationRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |