org.osid.calendaring.cycle

Interface CyclicTimePeriodForm

All Superinterfaces:

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

All Known Subinterfaces:

CyclicTimePeriodBatchForm

public interface CyclicTimePeriodForm
extends OsidObjectForm

This is the form for creating and updating CyclicTimePeriods. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the CyclicTimePeriodAdminSession. 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
CyclicTimePeriodFormRecord	getCyclicTimePeriodFormRecord(Type cyclicTimePeriodRecordType) Gets the CyclicTimePeriodFormRecord corresponding to the given cyclic time period 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

Method Detail

getCyclicTimePeriodFormRecord

CyclicTimePeriodFormRecord getCyclicTimePeriodFormRecord(Type cyclicTimePeriodRecordType)
                                                         throws OperationFailedException

Gets the CyclicTimePeriodFormRecord corresponding to the given cyclic time period record Type.

Parameters:

cyclicTimePeriodRecordType - the cyclic time period record type

Returns:

the cyclic time period form record

Throws:

NullArgumentException - cyclicTimePeriodRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(cyclicTimePeriodRecordType) is false

Compliance:

mandatory - This method must be implemented.