Interface AwardRequirement

All Superinterfaces:
Aggregateable, Browsable, Extensible, Identifiable, Operable, OsidObject, OsidRule
public interface AwardRequirement extends OsidRule, Aggregateable

A AwardRequirement is an OsidRule and represents a requirement based on an Award.

  • Method Details

    • getAltRequisites

      Requisite[] getAltRequisites()
      Gets any Requisites that may be substituted in place of this AwardRequirement. All Requisites must be satisifed to be a substitute for this award requirement. Inactive Requisites are not evaluated but if no applicable requisite exists, then the alternate requisite is not satisifed.
      Returns:
      the alternate requisites
      Compliance:
      mandatory - This method must be implemented.

    • getAwardId

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

    • getAward

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

    • hasTimeframe

      boolean hasTimeframe()
      Tests if the award must have been earned within the required duration.
      Returns:
      true if the award has to be earned within a required time, false if it could have been completed at any time in the past
      Compliance:
      mandatory - This method must be implemented.

    • getTimeframe

      Duration getTimeframe()
      Gets the timeframe in which the award has to be earned. A negative duration indicates the award had to be completed within the specified amount of time in the past. A posiitive duration indicates the award must be completed within the specified amount of time in the future. A zero duration indicates the award must be completed in the current term.
      Returns:
      the time frame
      Throws:
      IllegalStateException - hasTimeframe() is false
      Compliance:
      mandatory - This method must be implemented.

    • getAwardRequirementRecord

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