org.osid.course.registration

Interface ActivityBundleForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, Suppliable

All Known Subinterfaces:

ActivityBundleBatchForm

public interface ActivityBundleForm
extends OsidObjectForm

This is the form for creating and updating ActivityBundles. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ActivityBundleAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearCredits() Removes the credits.
void	clearGradingOptions() Removes the grading options.
ActivityBundleFormRecord	getActivityBundleFormRecord(Type activityBundleRecordType) Gets the ActivityBundleFormRecord corresponding to the given activity bundle record Type.
Metadata	getCreditsMetadata() Gets the metadata for credits.
Metadata	getGradingOptionsMetadata() Gets the metadata for a set of grading options.
void	setCredits(java.math.BigDecimal[] credits) Sets the activity bundle credits.
void	setGradingOptions(Id[] gradeSystemIds) Sets the grading options.

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Method Detail

getCreditsMetadata

Metadata getCreditsMetadata()

Gets the metadata for credits.

Returns:

metadata for the credits

Compliance:

mandatory - This method must be implemented.

setCredits

void setCredits(java.math.BigDecimal[] credits)

Sets the activity bundle credits.

Parameters:

credits - the new credits

Throws:

InvalidArgumentException - credits is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - credits is null

Compliance:

mandatory - This method must be implemented.

clearCredits

void clearCredits()

Removes the credits.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getGradingOptionsMetadata

Metadata getGradingOptionsMetadata()

Gets the metadata for a set of grading options.

Returns:

metadata for the grading options

Compliance:

mandatory - This method must be implemented.

setGradingOptions

void setGradingOptions(Id[] gradeSystemIds)

Sets the grading options.

Parameters:

gradeSystemIds - the new grade systems

Throws:

InvalidArgumentException - gradeSystemIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - gradeSystemIds is null

Compliance:

mandatory - This method must be implemented.

clearGradingOptions

void clearGradingOptions()

Removes the grading options.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getActivityBundleFormRecord

ActivityBundleFormRecord getActivityBundleFormRecord(Type activityBundleRecordType)
                                                     throws OperationFailedException

Gets the ActivityBundleFormRecord corresponding to the given activity bundle record Type.

Parameters:

activityBundleRecordType - an activity bundle record type

Returns:

the activity bundle form record

Throws:

NullArgumentException - activityBundleRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(activityBundleRecordType) is false

Compliance:

mandatory - This method must be implemented.