org.osid.course.registration

Interface ActivityRegistration

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal

public interface ActivityRegistration
extends OsidRelationship

An ActivityRegistration is an OsidRelationship between a student and an Activity for a Registration.

Method Summary

Methods

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.

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

getRegistrationId

Id getRegistrationId()

Gets the registration Id associated with this registration.

Returns:

the registration Id

Compliance:

mandatory - This method must be implemented.

getRegistration

Registration getRegistration()
                             throws OperationFailedException

Gets the registration associated with this registration.

Returns:

the registration

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getActivityId

Id getActivityId()

Gets the activity Id associated with this registration.

Returns:

the activity Id

Compliance:

mandatory - This method must be implemented.

getActivity

Activity getActivity()
                     throws OperationFailedException

Gets the activity associated with this registration.

Returns:

the activity

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.

getActivityRegistrationRecord

ActivityRegistrationRecord getActivityRegistrationRecord(Type activityRegistrationRecordType)
                                                         throws OperationFailedException

Gets the activity registration record corresponding to the given 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 .

Parameters:

activityRegistrationRecordType - the type of activity registration record to retrieve

Returns:

the activity registration record

Throws:

NullArgumentException - activityRegistrationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(activityRegistrationRecordType) is false

Compliance:

mandatory - This method must be implemented.