org.osid.course.registration

Interface Registration

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal

public interface Registration
extends OsidRelationship

A Registration is an OsidRelationship between a student and an ActivityBundle.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	definesCredits() Tests if this registration defines credits to be earned.
ActivityBundle	getActivityBundle() Gets the activity bundle associated with this registration.
Id	getActivityBundleId() Gets the activity bundle Id associated with this registration.
java.math.BigDecimal[]	getCredits() Gets the number of credits the student is registered to earn.
GradeSystem	getGradingOption() Gets the grading option for this registration.
Id	getGradingOptionId() Gets the grading option Id for this registration.
RegistrationRecord	getRegistrationRecord(Type registrationRecordType) Gets the registration record corresponding to the given Registration record Type.
Resource	getStudent() Gets the student Resource.
Id	getStudentId() Gets the Id of the student Resource.
boolean	isGraded() Tests if this registration includes a specific grading option.

Methods inherited from interface org.osid.OsidRelationship

getEndReason, getEndReasonId, hasEndReason

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

getActivityBundleId

Id getActivityBundleId()

Gets the activity bundle Id associated with this registration.

Returns:

the activity bundle Id

Compliance:

mandatory - This method must be implemented.

getActivityBundle

ActivityBundle getActivityBundle()
                                 throws OperationFailedException

Gets the activity bundle associated with this registration.

Returns:

the activity bundle

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getStudentId

Id getStudentId()

Gets the Id of the student Resource.

Returns:

the Student Id

Compliance:

mandatory - This method must be implemented.

getStudent

Resource getStudent()
                    throws OperationFailedException

Gets the student Resource.

Returns:

the student

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

definesCredits

boolean definesCredits()

Tests if this registration defines credits to be earned.

Returns:

true if this registration has credits, false otherwise

Compliance:

mandatory - This method must be implemented.

getCredits

java.math.BigDecimal[] getCredits()

Gets the number of credits the student is registered to earn. Multiple credit options indicates a set of credits to be determined at the completion of the course.

Returns:

the number of credits

Throws:

IllegalStateException - definesCredits() is false

Compliance:

mandatory - This method must be implemented.

isGraded

boolean isGraded()

Tests if this registration includes a specific grading option.

Returns:

true if this course is graded, false otherwise

Compliance:

mandatory - This method must be implemented.

getGradingOptionId

Id getGradingOptionId()

Gets the grading option Id for this registration.

Returns:

the grading option Id

Throws:

IllegalStateException - isGraded() is false

Compliance:

mandatory - This method must be implemented.

getGradingOption

GradeSystem getGradingOption()
                             throws OperationFailedException

Gets the grading option for this registration.

Returns:

a grading system

Throws:

IllegalStateException - isGraded() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getRegistrationRecord

RegistrationRecord getRegistrationRecord(Type registrationRecordType)
                                         throws OperationFailedException

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

Parameters:

registrationRecordType - the type of registration record to retrieve

Returns:

the registration record

Throws:

NullArgumentException - registrationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(registrationRecordType) is false

Compliance:

mandatory - This method must be implemented.