Interface CanonicalUnit

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

A Canonical Unit is an approved item to be offered.

Like all OsidObjects, CanonicalUnit is managed by its OsidSessions and may not be accessed by concurrent processing threads.

  • Method Details

    • getTitle

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

    • getCode

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

    • getOfferedCyclicTimePeriodIds

      IdList getOfferedCyclicTimePeriodIds()
      Gets the cyclic period Ids in which this CU can be offered. If there are no time cycles, then it can be offered any time.
      Returns:
      a list of cyclic period Ids
      Compliance:
      mandatory - This method must be implemented.

    • getOfferedCyclicTimePeriods

      CyclicTimePeriodList getOfferedCyclicTimePeriods() throws OperationFailedException
      Gets the cyclic periods in which this CU can be offered. If there are no time cycles, then it can be offered any time.
      Returns:
      a list of cyclic periods
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • hasResults

      boolean hasResults()
      Tests if this canonical has results when offered.
      Returns:
      true if this canonical 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 canonical unit.
      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 canonical has sponsors.
      Returns:
      true if this canonical 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.

    • getCanonicalUnitRecord

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