public interface Registration extends OsidRelationship
A Registration
is an OsidRelationship
between a student and an ActivityBundle.
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.
|
getEndReason, getEndReasonId, hasEndReason
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
Id getActivityBundleId()
Id
associated with this
registration. Id
mandatory
- This method must be implemented. ActivityBundle getActivityBundle() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getStudentId()
Id
of the student Resource.
Student
Id
mandatory
- This method must be implemented. Resource getStudent() throws OperationFailedException
Resource.
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean definesCredits()
true
if this registration has credits,
false
otherwisemandatory
- This method must be implemented. java.math.BigDecimal[] getCredits()
IllegalStateException
- definesCredits()
is false
mandatory
- This method must be implemented. boolean isGraded()
true
if this course is graded, false
otherwisemandatory
- This method must be implemented. Id getGradingOptionId()
Id
for this registration. Id
IllegalStateException
- isGraded()
is
false
mandatory
- This method must be implemented. GradeSystem getGradingOption() throws OperationFailedException
IllegalStateException
- isGraded()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. RegistrationRecord getRegistrationRecord(Type registrationRecordType) throws OperationFailedException
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
.registrationRecordType
- the type of registration record to
retrieveNullArgumentException
- registrationRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(registrationRecordType)
is false
mandatory
- This method must be implemented.