Interface ActivityRegistration

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Subjugateable, Temporal

public interface ActivityRegistration
extends OsidRelationship, Subjugateable

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

Method Summary

Modifier and Type	Method	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.
CourseRegistration	getCourseRegistration()	Gets the course registration associated with this registration.
Id	getCourseRegistrationId()	Gets the course 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 Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Modifier and Type	Method	Description
DisplayText	getDescription()	Gets the description associated with this instance of this OSID object.
DisplayText	getDisplayName()	Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.
Type	getGenusType()	Gets the genus type of this object.
boolean	isOfGenusType(Type genusType)	Tests if this object is of the given genus Type.

Methods inherited from interface OsidRelationship

getEndReason, getEndReasonId, hasEndReason

Modifier and Type	Method	Description
State	getEndReason()	Gets a state indicating why this relationship has ended.
Id	getEndReasonId()	Gets a state Id indicating why this relationship has ended.
boolean	hasEndReason()	Tests if a reason this relationship came to an end is known.

Methods inherited from interface Temporal

getEndDate, getStartDate, isEffective

Modifier and Type	Method	Description
DateTime	getEndDate()	Gets the end date.
DateTime	getStartDate()	Gets the start date.
boolean	isEffective()	Tests if the current date is within the start end end dates inclusive.

Method Details

getCourseRegistrationId

Id getCourseRegistrationId()

Gets the course registration Id associated with this registration.

Returns:

the course registration Id

Compliance:

mandatory - This method must be implemented.

getCourseRegistration

CourseRegistration getCourseRegistration()
                                  throws OperationFailedException

Gets the course registration associated with this registration.

Returns:

the course 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.