OSID Logo
OSID Specifications
recognition package
Version 3.1.0
Interfaceosid.recognition.Convocation
Implementsosid.OsidGovernator
Used Byosid.recognition.Conferral
osid.recognition.ConvocationAdminSession
osid.recognition.ConvocationList
osid.recognition.ConvocationLookupSession
Description

A Convocation is a set of Awards to be conferred.

MethodgetSponsorIds
Description

Gets the Ids of the sponsors.

Returnosid.id.IdList the sponsor Ids
Compliancemandatory This method must be implemented.
MethodgetSponsors
Description

Gets the sponsors.

Returnosid.resource.ResourceList the sponsors
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetAwardIds
Description

Gets the Ids of the awards.

Returnosid.id.IdList the award Ids
Compliancemandatory This method must be implemented.
MethodgetAwards
Description

Gets the awards.

Returnosid.recognition.AwardList the awards
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodhasTimePeriod
Description

Tests if the convocation confers awards for a period of time.

Returnboolean true if a time period exists, false otherwise
Compliancemandatory This method must be implemented.
MethodgetTimePeriodId
Description

Gets the Id of the time period.

Returnosid.id.Id the time period Id
ErrorsILLEGAL_STATE hasTimePeriod() is false
Compliancemandatory This method must be implemented.
MethodgetTimePeriod
Description

.Gets the time period.

Returnosid.calendaring.TimePeriod the time period
ErrorsILLEGAL_STATE hasTimePeriod() is false
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetDate
Description

Gets the date the awards in this convocation are to be conferred.

Returnosid.calendaring.DateTime the awards date
ErrorsILLEGAL_STATE hasTimePeriod() is true
Compliancemandatory This method must be implemented.
MethodgetConvocationRecord
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.

Parametersosid.type.TypeconvocationRecordType the type of convocation record to retrieve
Returnosid.recognition.records.ConvocationRecord the convocation record
ErrorsNULL_ARGUMENT convocationRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(convocationRecordType) is false
Compliancemandatory This method must be implemented.