OSID Logo
OSID Specifications
recognition package
Version 3.1.0
Interfaceosid.recognition.ConferralForm
Implementsosid.OsidRelationshipForm
Implemented Byosid.recognition.batch.ConferralBatchForm
Used Byosid.recognition.ConferralAdminSession
Description

This is the form for creating and updating Conferrals. Like all OsidForms, 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.Metadata metadata for the reference
Compliancemandatory This method must be implemented.
MethodsetReference
Description

Sets the date conferred.

Parametersosid.id.IdreferenceId the reference
ErrorsINVALID_ARGUMENT referenceId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT referenceId is null
Compliancemandatory This method must be implemented.
MethodclearReference
Description

Clears the reference.

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

Gets the metadata for the convocation.

Returnosid.Metadata metadata for the convocation
Compliancemandatory This method must be implemented.
MethodsetConvocation
Description

Sets the convocation.

Parametersosid.id.IdconvocationId the convocation Id
ErrorsINVALID_ARGUMENT convocationId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT convocationId is null
Compliancemandatory This method must be implemented.
MethodclearConvocation
Description

Clears the convocation.

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

Gets the ConferralFormRecord corresponding to the given conferral record Type.

Parametersosid.type.TypeconferralRecordType the conferral record type
Returnosid.recognition.records.ConferralFormRecord the conferral form record
ErrorsNULL_ARGUMENT conferralRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(conferralRecordType) is false
Compliancemandatory This method must be implemented.