OSID - osid.recognition.Convocation Service Interface Definition

Interface	osid.recognition.Convocation
Implements	`osid.OsidGovernator`
Description	A `Convocation` is a set of `Awards` to be conferred.
Method	getAwardIds
Description	Gets the `Ids` of the awards.
Return	`osid.id.IdList`		the award `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getAwards
Description	Gets the awards.
Return	`osid.recognition.AwardList`		the awards
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasTimePeriod
Description	Tests if the convocation confers awards for a period of time.
Return	`boolean`		`true` if a time period exists, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriodId
Description	Gets the `Id` of the time period.
Return	`osid.id.Id`		the time period `Id`
Errors	ILLEGAL_STATE		`hasTimePeriod()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriod
Description	.Gets the time period.
Return	`osid.calendaring.TimePeriod`		the time period
Errors	ILLEGAL_STATE		`hasTimePeriod()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getDate
Description	Gets the date the awards in this convocation are to be conferred.
Return	`osid.calendaring.DateTime`		the awards date
Errors	ILLEGAL_STATE		`hasTimePeriod()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getConvocationRecord
Description	Gets the convocation record corresponding to the given `Convocation` record `Type.` This method is used to retrieve an object implementing the requested record. The `convocationRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(convocationRecordType)` is `true` .
Parameters	`osid.type.Type`	`convocationRecordType`	the type of convocation record to retrieve
Return	`osid.recognition.records.ConvocationRecord`		the convocation 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.