Interface Conferral

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal
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.

  • Method Details

    • getAwardId

      Id getAwardId()
      Gets the Id of the subscriber's award.
      Returns:
      the subscriber Id
      Compliance:
      mandatory - This method must be implemented.

    • getAward

      Award getAward() throws OperationFailedException
      Gets the subscriber's award.
      Returns:
      the subscriber's award.
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getRecipientId

      Id getRecipientId()
      Gets the Id of the recipient.
      Returns:
      the resource Id
      Compliance:
      mandatory - This method must be implemented.

    • getRecipient

      Resource getRecipient() throws OperationFailedException
      Gets the recipient (e.g. Samuel Goldwyn).
      Returns:
      the resource
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • hasReference

      boolean hasReference()
      Tests if the was conferred for a reference object.
      Returns:
      true if a reference exists, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getReferenceId

      Id getReferenceId()
      Gets the Id of the reference (e.g. "Best Years of Our Lives").
      Returns:
      the reference Id
      Throws:
      IllegalStateException - hasReference() is false
      Compliance:
      mandatory - This method must be implemented.

    • hasConvocation

      boolean hasConvocation()
      Tests if the award was conferred as part of a convocation.
      Returns:
      true if a convocation exists, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getConvocationId

      Id getConvocationId()
      Gets the Id of the convocation.
      Returns:
      the convocation Id
      Throws:
      IllegalStateException - hasConvocation() is false
      Compliance:
      mandatory - This method must be implemented.

    • getConvocation

      Convocation getConvocation() throws OperationFailedException
      Gets the convocation (e.g. 19th Academy Awards for the time period 1946).
      Returns:
      the convocation
      Throws:
      IllegalStateException - hasConvocation() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getConferralRecord

      ConferralRecord getConferralRecord(Type conferralRecordType) throws OperationFailedException
      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 .
      Parameters:
      conferralRecordType - the type of conferral record to retrieve
      Returns:
      the conferral record
      Throws:
      NullArgumentException - conferralRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(conferralRecordType) is false
      Compliance:
      mandatory - This method must be implemented.