Interface Convocation

All Superinterfaces:
Browsable, Extensible, Identifiable, Operable, OsidGovernator, OsidObject
public interface Convocation extends OsidGovernator

A Convocation is a set of Awards to be conferred.

  • Method Details

    • getSponsorIds

      IdList getSponsorIds()
      Gets the Ids of the sponsors.
      Returns:
      the sponsor Ids
      Compliance:
      mandatory - This method must be implemented.

    • getSponsors

      ResourceList getSponsors() throws OperationFailedException
      Gets the sponsors.
      Returns:
      the sponsors
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getAwardIds

      IdList getAwardIds()
      Gets the Ids of the awards.
      Returns:
      the award Ids
      Compliance:
      mandatory - This method must be implemented.

    • getAwards

      AwardList getAwards() throws OperationFailedException
      Gets the awards.
      Returns:
      the awards
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • hasTimePeriod

      boolean hasTimePeriod()
      Tests if the convocation confers awards for a period of time.
      Returns:
      true if a time period exists, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getTimePeriodId

      Id getTimePeriodId()
      Gets the Id of the time period.
      Returns:
      the time period Id
      Throws:
      IllegalStateException - hasTimePeriod() is false
      Compliance:
      mandatory - This method must be implemented.

    • getTimePeriod

      TimePeriod getTimePeriod() throws OperationFailedException
      .Gets the time period.
      Returns:
      the time period
      Throws:
      IllegalStateException - hasTimePeriod() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getDate

      DateTime getDate()
      Gets the date the awards in this convocation are to be conferred.
      Returns:
      the awards date
      Throws:
      IllegalStateException - hasTimePeriod() is true
      Compliance:
      mandatory - This method must be implemented.

    • getConvocationRecord

      ConvocationRecord getConvocationRecord(Type convocationRecordType) throws OperationFailedException
      Gets the convocation record corresponding to the given Convocation record Type. This method is used to retrieve an object implementing the requested record. The convocationRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(convocationRecordType) is true.
      Parameters:
      convocationRecordType - the type of convocation record to retrieve
      Returns:
      the convocation record
      Throws:
      NullArgumentException - convocationRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(convocationRecordType) is false
      Compliance:
      mandatory - This method must be implemented.