Interface Offering

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal
public interface Offering extends OsidRelationship

An Offering is an OsidRelationship between a CanonicalUnit and a TimePeriod .

  • Method Details

    • getCanonicalUnitId

      Id getCanonicalUnitId()
      Gets the Id of the canonical unit.
      Returns:
      the canonical unit Id
      Compliance:
      mandatory - This method must be implemented.

    • getCanonicalUnit

      CanonicalUnit getCanonicalUnit() throws OperationFailedException
      Gets the canonical of this offering.
      Returns:
      the canonical unit
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getTimePeriodId

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

    • getTimePeriod

      TimePeriod getTimePeriod() throws OperationFailedException
      Gets the time period of this offering
      Returns:
      the time period
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getTitle

      DisplayText getTitle()
      Gets the title for this offering.
      Returns:
      the title
      Compliance:
      mandatory - This method must be implemented.

    • getCode

      String getCode()
      Gets the code for this offering.
      Returns:
      the code
      Compliance:
      mandatory - This method must be implemented.

    • hasResults

      boolean hasResults()
      Tests if this offering has results when offered.
      Returns:
      true if this offering has results, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getResultOptionIds

      IdList getResultOptionIds()
      Gets the various result option Ids allowed for results.
      Returns:
      the returned list of grading option Ids
      Throws:
      IllegalStateException - hasResults() is false
      Compliance:
      mandatory - This method must be implemented.

    • getResultOptions

      GradeSystemList getResultOptions() throws OperationFailedException
      Gets the various result options allowed for this offering.
      Returns:
      the returned list of grading options
      Throws:
      IllegalStateException - hasResults() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • hasSponsors

      boolean hasSponsors()
      Tests if this offering has sponsors.
      Returns:
      true if this offering has sponsors, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getSponsorIds

      IdList getSponsorIds()
      Gets the sponsor Ids .
      Returns:
      the sponsor Ids
      Throws:
      IllegalStateException - hasSponsors() is false
      Compliance:
      mandatory - This method must be implemented.

    • getSponsors

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

    • getScheduleIds

      IdList getScheduleIds()
      Gets the schedule Ids associated with this offering.
      Returns:
      the schedule Ids
      Compliance:
      mandatory - This method must be implemented.

    • getSchedules

      ScheduleList getSchedules() throws OperationFailedException
      Gets the schedules associated with this offering.
      Returns:
      the schedules
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getOfferingRecord

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