org.osid.course.registration

Interface ActivityRegistrationForm

All Superinterfaces:

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

All Known Subinterfaces:

ActivityRegistrationBatchForm

public interface ActivityRegistrationForm
extends OsidRelationshipForm

This is the form for creating and updating ActivityRegistrations. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ActivityRegistrationAdminSession. 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
ActivityRegistrationFormRecord	getActivityRegistrationFormRecord(Type activityRegistrationRecordType) Gets the ActivityRegistrationFormRecord corresponding to the given activity registration record Type.

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

Methods inherited from interface org.osid.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

getActivityRegistrationFormRecord

ActivityRegistrationFormRecord getActivityRegistrationFormRecord(Type activityRegistrationRecordType)
                                                                 throws OperationFailedException

Gets the ActivityRegistrationFormRecord corresponding to the given activity registration record Type.

Parameters:

activityRegistrationRecordType - an activity registration record type

Returns:

the activity registration form record

Throws:

NullArgumentException - activityRegistrationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(activityRegistrationRecordType) is false

Compliance:

mandatory - This method must be implemented.