OSID Logo
OSID Specifications
recognition package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recognition.Conferral
Implementsosid.OsidRelationship
Description

A Conferral represents an Award conferred to a Recipient for something (reference). Often, an award is conferred for a body of work. The body of work may be represented by another OsidObject, such as an Asset or an Assessment may be related using an Id. The recipiens is the Resource to whom the award is addressed is often the producer or creator of the work. In some instances, the Resource and the reference may be one in the same.

MethodgetAwardId
Description

Gets the Id of the subscriber's award.

Returnosid.id.Idthe subscriber Id
CompliancemandatoryThis method must be implemented.
MethodgetAward
Description

Gets the subscriber's award.

Returnosid.recognition.Awardthe subscriber's award.
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetRecipientId
Description

Gets the Id of the recipient.

Returnosid.id.Idthe resource Id
CompliancemandatoryThis method must be implemented.
MethodgetRecipient
Description

Gets the recipient (e.g. Samuel Goldwyn).

Returnosid.resource.Resourcethe resource
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodhasReference
Description

Tests if the was conferred for a reference object.

Returnboolean true if a reference exists, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetReferenceId
Description

Gets the Id of the reference (e.g. "Best Years of Our Lives").

Returnosid.id.Idthe reference Id
ErrorsILLEGAL_STATE hasReference() is false
CompliancemandatoryThis method must be implemented.
MethodhasConvocation
Description

Tests if the award was conferred as part of a convocation.

Returnboolean true if a convocation exists, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetConvocationId
Description

Gets the Id of the convocation.

Returnosid.id.Idthe convocation Id
ErrorsILLEGAL_STATE hasConvocation() is false
CompliancemandatoryThis method must be implemented.
MethodgetConvocation
Description

Gets the convocation (e.g. 19th Academy Awards for the time period 1946).

Returnosid.recognition.Convocationthe convocation
ErrorsILLEGAL_STATE hasConvocation() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetConferralRecord
Description

Gets the conferral record corresponding to the given Conferral record Type. This method is used to retrieve an object implementing the requested record. The conferralRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(conferralRecordType) is true .

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