org.osid.financials.budgeting.batch

Interface BudgetBatchForm

All Superinterfaces:

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

public interface BudgetBatchForm
extends BusinessForm

This is the form for creating and updating budgets in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the BudgetBatchAdminSession. 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	getActivityId() Gets the Id of the activity if this is a create transaction.
Id	getBudgetId() Gets the Id of the budget to be updated if this is an update transaction.
Id	getFiscalPeriodId() Gets the Id of the fiscal period if this is a create transaction.

Methods inherited from interface org.osid.financials.BusinessForm

getBusinessFormRecord

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

getActivityId

Id getActivityId()

Gets the Id of the activity if this is a create transaction.

Returns:

the activity Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getFiscalPeriodId

Id getFiscalPeriodId()

Gets the Id of the fiscal period if this is a create transaction.

Returns:

the fiscal period Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getBudgetId

Id getBudgetId()

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

Returns:

the budget Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.