public interface Participant extends OsidRelationship
A Participant
in an OsidRelationship
between an Offering
and a Resource.
Modifier and Type | Method and Description |
---|---|
Offering |
getOffering()
Gets the offering for this participant.
|
Id |
getOfferingId()
Gets the
Id of the offering to which this participant
is assigned. |
ParticipantRecord |
getParticipantRecord(Type participantRecordType)
Gets the record corresponding to the given
Participant
record Type. |
Resource |
getResource()
Gets the resource for this participant.
|
Id |
getResourceId()
Gets the
Id of the resource. |
IdList |
getResultOptionIds()
Gets the various result option
Ids applied to this
participation. |
GradeSystemList |
getResultOptions()
Gets the various result option
Ids applied to this
participation. |
TimePeriod |
getTimePeriod()
Gets the time period for this participant.
|
Id |
getTimePeriodId()
Gets the
Id of the time period. |
boolean |
hasResults()
Tests if there are result options that inform or constrain the
results.
|
getEndReason, getEndReasonId, hasEndReason
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
Id getOfferingId()
Id
of the offering to which this participant
is assigned. Offering
Id
mandatory
- This method must be implemented. Offering getOffering() throws OperationFailedException
Offering
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getResourceId()
Id
of the resource. Resource
Id
mandatory
- This method must be implemented. Resource getResource() throws OperationFailedException
Resource
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getTimePeriodId()
Id
of the time period. TimePeriod
Id
mandatory
- This method must be implemented. TimePeriod getTimePeriod() throws OperationFailedException
TimePeriod
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean hasResults()
true
if there are results, false
otherwisemandatory
- This method must be implemented. IdList getResultOptionIds()
Ids
applied to this
participation. Ids
IllegalStateException
- hasResults()
is
false
mandatory
- This method must be implemented. GradeSystemList getResultOptions() throws OperationFailedException
Ids
applied to this
participation.IllegalStateException
- hasResults()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. ParticipantRecord getParticipantRecord(Type participantRecordType) throws OperationFailedException
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
.participantRecordType
- the type of participant record to
retrieveNullArgumentException
- participantRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(participantRecordType)
is false
mandatory
- This method must be implemented.