Interface Participant

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

A Participant in an OsidRelationship between an Offering and a Resource .

  • Method Details

    • getOfferingId

      Id getOfferingId()
      Gets the Id of the offering to which this participant is assigned.
      Returns:
      the Offering Id
      Compliance:
      mandatory - This method must be implemented.

    • getOffering

      Offering getOffering() throws OperationFailedException
      Gets the offering for this participant.
      Returns:
      the Offering
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getResourceId

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

    • getResource

      Resource getResource() throws OperationFailedException
      Gets the resource for this participant.
      Returns:
      the Resource
      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 TimePeriod Id
      Compliance:
      mandatory - This method must be implemented.

    • getTimePeriod

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

    • hasResults

      boolean hasResults()
      Tests if there are result options that inform or constrain the results.
      Returns:
      true if there are results, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getResultOptionIds

      IdList getResultOptionIds()
      Gets the various result option Ids applied to this participation.
      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 option Ids applied to this participation.
      Returns:
      the returned list of grading options
      Throws:
      IllegalStateException - hasResults() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getParticipantRecord

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