public interface Conferral extends OsidRelationship
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.
Modifier and Type | Method and Description |
---|---|
Award |
getAward()
Gets the subscriber's award.
|
Id |
getAwardId()
Gets the
Id of the subscriber's award. |
ConferralRecord |
getConferralRecord(Type conferralRecordType)
Gets the conferral record corresponding to the given
Conferral
record Type. |
Convocation |
getConvocation()
Gets the convocation (e.g.
|
Id |
getConvocationId()
Gets the
Id of the convocation. |
Resource |
getRecipient()
Gets the recipient (e.g.
|
Id |
getRecipientId()
Gets the
Id of the recipient. |
Id |
getReferenceId()
Gets the
Id of the reference (e.g. |
boolean |
hasConvocation()
Tests if the award was conferred as part of a convocation.
|
boolean |
hasReference()
Tests if the was conferred for a reference object.
|
getEndReason, getEndReasonId, hasEndReason
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
Id getAwardId()
Id
of the subscriber's award. Id
mandatory
- This method must be implemented. Award getAward() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getRecipientId()
Id
of the recipient. Id
mandatory
- This method must be implemented. Resource getRecipient() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean hasReference()
true
if a reference exists, false
otherwisemandatory
- This method must be implemented. Id getReferenceId()
Id
of the reference (e.g. "Best Years of Our
Lives"). Id
IllegalStateException
- hasReference()
is false
mandatory
- This method must be implemented. boolean hasConvocation()
true
if a convocation exists, false
otherwisemandatory
- This method must be implemented. Id getConvocationId()
Id
of the convocation. Id
IllegalStateException
- hasConvocation()
is false
mandatory
- This method must be implemented. Convocation getConvocation() throws OperationFailedException
IllegalStateException
- hasConvocation()
is false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. ConferralRecord getConferralRecord(Type conferralRecordType) throws OperationFailedException
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
.conferralRecordType
- the type of conferral record to retrieveNullArgumentException
- conferralRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(conferralRecordType)
is false
mandatory
- This method must be implemented.