OSID Logo
OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.Participant
Implementsosid.OsidRelationship
Description

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

MethodgetOfferingId
Description

Gets the Id of the offering to which this participant is assigned.

Returnosid.id.Idthe Offering Id
CompliancemandatoryThis method must be implemented.
MethodgetOffering
Description

Gets the offering for this participant.

Returnosid.offering.Offeringthe Offering
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetResourceId
Description

Gets the Id of the resource.

Returnosid.id.Idthe Resource Id
CompliancemandatoryThis method must be implemented.
MethodgetResource
Description

Gets the resource for this participant.

Returnosid.resource.Resourcethe Resource
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetTimePeriodId
Description

Gets the Id of the time period.

Returnosid.id.Idthe TimePeriod Id
CompliancemandatoryThis method must be implemented.
MethodgetTimePeriod
Description

Gets the time period for this participant.

Returnosid.calendaring.TimePeriodthe TimePeriod
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodhasResults
Description

Tests if there are result options that inform or constrain the results.

Returnboolean true if there are results, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetResultOptionIds
Description

Gets the various result option Ids applied to this participation.

Returnosid.id.IdListthe returned list of grading option Ids
ErrorsILLEGAL_STATE hasResults() is false
CompliancemandatoryThis method must be implemented.
MethodgetResultOptions
Description

Gets the various result option Ids applied to this participation.

Returnosid.grading.GradeSystemListthe returned list of grading options
ErrorsILLEGAL_STATE hasResults() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetParticipantRecord
Description

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 .

Parametersosid.type.TypeparticipantRecordTypethe type of participant record to retrieve
Returnosid.offering.records.ParticipantRecordthe participant record
ErrorsNULL_ARGUMENT participantRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(participantRecordType) is false
CompliancemandatoryThis method must be implemented.