public interface ActivityRegistration extends OsidRelationship
An ActivityRegistration
is an OsidRelationship
between a student and an Activity
for a
Registration.
Modifier and Type | Method and Description |
---|---|
Activity |
getActivity()
Gets the activity associated with this registration.
|
Id |
getActivityId()
Gets the activity
Id associated with this registration. |
ActivityRegistrationRecord |
getActivityRegistrationRecord(Type activityRegistrationRecordType)
Gets the activity registration record corresponding to the given
ActivityRegistration record Type. |
Registration |
getRegistration()
Gets the registration associated with this registration.
|
Id |
getRegistrationId()
Gets the registration
Id associated with this
registration. |
Resource |
getStudent()
Gets the student
Resource. |
Id |
getStudentId()
Gets the
Id of the student Resource. |
getEndReason, getEndReasonId, hasEndReason
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
Id getRegistrationId()
Id
associated with this
registration. Id
mandatory
- This method must be implemented. Registration getRegistration() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getActivityId()
Id
associated with this registration. Id
mandatory
- This method must be implemented. Activity getActivity() 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. ActivityRegistrationRecord getActivityRegistrationRecord(Type activityRegistrationRecordType) throws OperationFailedException
ActivityRegistration
record Type.
This
method is used to retrieve an object implementing the requested
record. The activityRegistrationRecordType
may be the
Type
returned in getRecordTypes()
or any
of its parents in a Type
hierarchy where
hasRecordType(activityRegistrationRecordType)
is true
.activityRegistrationRecordType
- the type of activity
registration record to retrieveNullArgumentException
-
activityRegistrationRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(activityRegistrationRecordType)
is
false
mandatory
- This method must be implemented.