org.osid.calendaring

Interface CalendarForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidCatalogForm, OsidExtensibleForm, OsidFederateableForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSourceableForm, Suppliable

All Known Subinterfaces:

CalendarBatchForm

public interface CalendarForm
extends OsidCatalogForm

This is the form for creating and updating calendars. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the CalendarAdminSession. 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
CalendarFormRecord	getCalendarFormRecord(Type calendarRecordType) Gets the CalendarFormRecord corresponding to the given calendar 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.OsidSourceableForm

clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider

Method Detail

getCalendarFormRecord

CalendarFormRecord getCalendarFormRecord(Type calendarRecordType)
                                         throws OperationFailedException

Gets the CalendarFormRecord corresponding to the given calendar record Type.

Parameters:

calendarRecordType - a calendar record type

Returns:

the calendar form record

Throws:

NullArgumentException - calendarRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(calendarRecordType) is false

Compliance:

mandatory - This method must be implemented.