org.osid.offering

Interface Result

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, Subjugateable, Temporal

public interface Result
extends OsidObject, Temporal, Subjugateable

An Result is an outcome from a Participation.

Method Summary

Methods

Modifier and Type	Method and Description
Grade	getGrade() Gets the grade in this entry if the grading system is based on grades.
Id	getGradeId() Gets the grade Id in this entry if the grading system is based on grades.
Participant	getParticipant() Gets the participant in this result.
Id	getParticipantId() Gets the Id of the participant in this result.
ResultRecord	getResultRecord(Type resultRecordType) Gets the record corresponding to the given Result record Type.
java.math.BigDecimal	getValue() Gets the value in this entry if the grading system is not based on grades.
boolean	isGraded() Tests if a grade or score has been assigned to this entry.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

getParticipantId

Id getParticipantId()

Gets the Id of the participant in this result.

Returns:

the Participant Id

Compliance:

mandatory - This method must be implemented.

getParticipant

Participant getParticipant()
                           throws OperationFailedException

Gets the participant in this result.

Returns:

the Participant

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

isGraded

boolean isGraded()

Tests if a grade or score has been assigned to this entry. Generally, an entry is created with a grade or score.

Returns:

true if a grade has been assigned, false otherwise

Compliance:

mandatory - This method must be implemented.

getGradeId

Id getGradeId()

Gets the grade Id in this entry if the grading system is based on grades.

Returns:

the grade Id

Throws:

IllegalStateException - isGraded() is false or GradeSystem.isBasedOnGrades() is false

Compliance:

mandatory - This method must be implemented.

getGrade

Grade getGrade()
               throws OperationFailedException

Gets the grade in this entry if the grading system is based on grades.

Returns:

the grade

Throws:

IllegalStateException - isGraded() is false or GradeSystem.isBasedOnGrades() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getValue

java.math.BigDecimal getValue()

Gets the value in this entry if the grading system is not based on grades.

Returns:

the value

Throws:

IllegalStateException - isGraded() is false or GradeSystem.isBasedOnGrades() is true

Compliance:

mandatory - This method must be implemented.

getResultRecord

ResultRecord getResultRecord(Type resultRecordType)
                             throws OperationFailedException

Gets the record corresponding to the given Result record Type. This method is used to retrieve an object implementing the requested record. The resultRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(resultRecordType) is true .

Parameters:

resultRecordType - the type of result record to retrieve

Returns:

the result record

Throws:

NullArgumentException - resultRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(resultRecordType) is false

Compliance:

mandatory - This method must be implemented.