OSID Logo
OSID Specifications
recognition package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recognition.ConvocationForm
Implementsosid.OsidGovernatorForm
Description

This is the form for creating and updating Convocation objects. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ConvocationAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetAwardsMetadata
Description

Gets the metadata for the awards.

Returnosid.Metadatametadata for the awards
CompliancemandatoryThis method must be implemented.
MethodsetAwards
Description

Sets the list of awards.

Parametersosid.id.Id[]awardIdsa list of award Ids
ErrorsINVALID_ARGUMENT awardIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT awardIds is null
CompliancemandatoryThis method must be implemented.
MethodclearAwards
Description

Clears the awards.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetDateMetadata
Description

Gets the metadata for the date.

Returnosid.Metadatametadata for the date
CompliancemandatoryThis method must be implemented.
MethodsetDate
Description

Sets the date.

Parametersosid.calendaring.DateTimedatea date
ErrorsINVALID_ARGUMENT date is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT date is null
CompliancemandatoryThis method must be implemented.
MethodclearDate
Description

Clears the date.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetTimePeriodMetadata
Description

Gets the metadata for the time period.

Returnosid.Metadatametadata for the time period
CompliancemandatoryThis method must be implemented.
MethodsetTimePeriod
Description

Sets the time period.

Parametersosid.id.IdtimePeriodIdthe time period Id
ErrorsINVALID_ARGUMENT timePeriodId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT timePeriodId is null
CompliancemandatoryThis method must be implemented.
MethodclearTimePeriod
Description

Clears the time period.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetConvocationFormRecord
Description

Gets the ConvocationFormRecord corresponding to the given convocation record Type.

Parametersosid.type.TypeconvocationRecordTypethe convocation record type
Returnosid.recognition.records.ConvocationFormRecordthe convocation form record
ErrorsNULL_ARGUMENT convocationRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(convocationRecordType) is false
CompliancemandatoryThis method must be implemented.