OSID Logo
OSID Specifications
recognition package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recognition.ConferralForm
Implementsosid.OsidRelationshipForm
Description

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

MethodgetReferenceMetadata
Description

Gets the metadata for the reference.

Returnosid.Metadatametadata for the reference
CompliancemandatoryThis method must be implemented.
MethodsetReference
Description

Sets the date conferred.

Parametersosid.id.IdreferenceIdthe reference
ErrorsINVALID_ARGUMENT referenceId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT referenceId is null
CompliancemandatoryThis method must be implemented.
MethodclearReference
Description

Clears the reference.

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

Gets the metadata for the convocation.

Returnosid.Metadatametadata for the convocation
CompliancemandatoryThis method must be implemented.
MethodsetConvocation
Description

Sets the convocation.

Parametersosid.id.IdconvocationIdthe convocation Id
ErrorsINVALID_ARGUMENT convocationId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT convocationId is null
CompliancemandatoryThis method must be implemented.
MethodclearConvocation
Description

Clears the convocation.

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

Gets the ConferralFormRecord corresponding to the given conferral record Type.

Parametersosid.type.TypeconferralRecordTypethe conferral record type
Returnosid.recognition.records.ConferralFormRecordthe conferral form record
ErrorsNULL_ARGUMENT conferralRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(conferralRecordType) is false
CompliancemandatoryThis method must be implemented.