Interface PeriodBatchForm

All Superinterfaces:

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

public interface PeriodBatchForm
extends PeriodForm

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

Like all OsidForms, PeriodBatchForm is stateful and must not be accessed by multiple processing threads.

Method Summary

Modifier and Type	Method	Description
Id	getPeriodId()	Gets the Id of the period to be updated if this is an update transaction.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Methods inherited from interface Identifiable

getId, isCurrent

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface OsidForm

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

Methods inherited from interface OsidObjectForm

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

Methods inherited from interface PeriodForm

clearBillingDate, clearCloseDate, clearDisplayLabel, clearDueDate, clearOpenDate, getBillingDateMetadata, getCloseDateMetadata, getDisplayLabelMetadata, getDueDateMetadata, getOpenDateMetadata, getPeriodFormRecord, setBillingDate, setCloseDate, setDisplayLabel, setDueDate, setOpenDate

Method Details

getPeriodId

Id getPeriodId()

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

Returns:

the period Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.