org.osid.calendaring.cycle.batch

Interface CyclicTimePeriodBatchForm

All Superinterfaces:

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

public interface CyclicTimePeriodBatchForm
extends CyclicTimePeriodForm

This is the form for creating and updating cyclic time periods in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the CyclicTimePeriodBatchAdminSession. 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
Id	getCyclicTimePeriodId() Gets the Id of the cyclic time period to be updated if this is an update transaction.

Methods inherited from interface org.osid.calendaring.cycle.CyclicTimePeriodForm

getCyclicTimePeriodFormRecord

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

getCyclicTimePeriodId

Id getCyclicTimePeriodId()

Gets the Id of the cyclic time period to be updated if this is an update transaction.

Returns:

the cyclic time period Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.