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.

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

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm .

Methods inherited from interface OsidForm

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

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

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

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Methods inherited from interface PeriodForm

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

Modifier and Type	Method	Description
void	clearBillingDate()	Clears the billing date.
void	clearCloseDate()	Clears the close date.
void	clearDisplayLabel()	Removes the display label.
void	clearDueDate()	Clears the due date.
void	clearOpenDate()	Clears the open date.
Metadata	getBillingDateMetadata()	Gets the metadata for the billing date.
Metadata	getCloseDateMetadata()	Gets the metadata for the close date.
Metadata	getDisplayLabelMetadata()	Gets the metadata for a display label title.
Metadata	getDueDateMetadata()	Gets the metadata for the due date.
Metadata	getOpenDateMetadata()	Gets the metadata for an open date.
PeriodFormRecord	getPeriodFormRecord(Type periodRecordType)	Gets the PeriodFormRecord corresponding to the given period record Type .
void	setBillingDate(DateTime date)	Sets the billing date.
void	setCloseDate(DateTime date)	Sets the close date.
void	setDisplayLabel(String displayLabel)	Sets the display label.
void	setDueDate(DateTime date)	Sets the due date.
void	setOpenDate(DateTime date)	Sets the open date.

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.