org.osid.course.registration

Interface ActivityBundle

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject

public interface ActivityBundle
extends OsidObject

An ActivityBundle represents a set of Activities in which a Registration is permissable.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	definesCredits() Tests if registration to this bundle results in credits to be earned.
ActivityList	getActivities() Gets the activities in this bundle.
ActivityBundleRecord	getActivityBundleRecord(Type activityBundleRecordType) Gets the activity bundle record corresponding to the given ActivityBundle record Type.
IdList	getActivityIds() Gets the activity Ids in this bundle.
CourseOffering	getCourseOffering() Gets the course offering associated with this activity bundle.
Id	getCourseOfferingId() Gets the course offering Id associated with this activity bundle.
java.math.BigDecimal[]	getCredits() Gets the number of credits available to register for in this course.
IdList	getGradingOptionIds() Gets the various grading option Ids available to register in this course.
GradeSystemList	getGradingOptions() Gets the various grading options available to register in this course.
boolean	isGraded() Tests if a registration to this bundle will be for for grades.

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

Method Detail

getCourseOfferingId

Id getCourseOfferingId()

Gets the course offering Id associated with this activity bundle.

Returns:

the course offering Id

Compliance:

mandatory - This method must be implemented.

getCourseOffering

CourseOffering getCourseOffering()
                                 throws OperationFailedException

Gets the course offering associated with this activity bundle.

Returns:

the course offering

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getActivityIds

IdList getActivityIds()

Gets the activity Ids in this bundle.

Returns:

Ids of the l earning objectives

Compliance:

mandatory - This method is must be implemented.

getActivities

ActivityList getActivities()
                           throws OperationFailedException

Gets the activities in this bundle.

Returns:

the activites

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

definesCredits

boolean definesCredits()

Tests if registration to this bundle results in credits to be earned.

Returns:

true if this course has credits, false otherwise

Compliance:

mandatory - This method must be implemented.

getCredits

java.math.BigDecimal[] getCredits()

Gets the number of credits available to register for in this course. Each array element is a distinct option.

Returns:

the number of credits

Throws:

IllegalStateException - definesCredits() is false

Compliance:

mandatory - This method must be implemented.

isGraded

boolean isGraded()

Tests if a registration to this bundle will be for for grades.

Returns:

true if this registration is for grades, false otherwise

Compliance:

mandatory - This method must be implemented.

getGradingOptionIds

IdList getGradingOptionIds()

Gets the various grading option Ids available to register in this course.

Returns:

the returned list of grading option Ids

Throws:

IllegalStateException - isGraded() is false

Compliance:

mandatory - This method must be implemented.

getGradingOptions

GradeSystemList getGradingOptions()
                                  throws OperationFailedException

Gets the various grading options available to register in this course.

Returns:

the returned list of grading options

Throws:

IllegalStateException - isGraded() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getActivityBundleRecord

ActivityBundleRecord getActivityBundleRecord(Type activityBundleRecordType)
                                             throws OperationFailedException

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

Parameters:

activityBundleRecordType - the type of activity bundle record to retrieve

Returns:

the activity bundle record

Throws:

NullArgumentException - activityBundleRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(activityBundleRecordType) is false

Compliance:

mandatory - This method must be implemented.