org.osid.billing.batch

Interface EntryBatchForm

All Superinterfaces:

EntryForm, Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidRelationshipForm, OsidTemporalForm, Suppliable

public interface EntryBatchForm
extends EntryForm

This is the form for creating and updating entries in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the EntryBatchAdminSession. 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	getCustomerId() Gets the Customer Id of the entry if this is a create transaction.
Id	getEntryId() Gets the Id of the entry to be updated if this is an update transaction.
Id	getItemId() Gets the Item Id of the entry if this is a create transaction.
Id	getPeriodId() Gets the period Id of the entry if this is a create transaction.

Methods inherited from interface org.osid.billing.EntryForm

clearAmount, clearDebit, clearQuantity, getAmountMetadata, getDebitMetadata, getEntryFormRecord, getQuantityMetadata, setAmount, setDebit, setQuantity

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.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

getCustomerId

Id getCustomerId()

Gets the Customer Id of the entry if this is a create transaction.

Returns:

the customer Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getItemId

Id getItemId()

Gets the Item Id of the entry if this is a create transaction.

Returns:

the item Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getPeriodId

Id getPeriodId()

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

Returns:

the period Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getEntryId

Id getEntryId()

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

Returns:

the entry Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.