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

Modifier and Type	Method	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 EntryForm

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

Modifier and Type	Method	Description
void	clearAmount()	Removes the amount.
void	clearDebit()	Clears the debit flag.
void	clearQuantity()	Removes the quantity.
Metadata	getAmountMetadata()	Gets the metadata for the amount.
Metadata	getDebitMetadata()	Gets the metadata for the debit flag.
EntryFormRecord	getEntryFormRecord(Type entryRecordType)	Gets the EntryFormRecord corresponding to the given entry record Type .
Metadata	getQuantityMetadata()	Gets the metadata for the quantity.
void	setAmount(Currency amount)	Sets the amount.
void	setDebit(boolean debit)	Sets the debit flag.
void	setQuantity(long quantity)	Sets the quantity.

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 OsidRelationshipForm

clearEndReason, getEndReasonMetadata, setEndReason

Modifier and Type	Method	Description
void	clearEndReason()	Removes the end reason.
Metadata	getEndReasonMetadata()	Gets the metadata for the end reason.
void	setEndReason(Id stateId)	Sets the end reason.

Methods inherited from interface OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Modifier and Type	Method	Description
void	clearEndDate()	Clears the end date.
void	clearStartDate()	Clears the start date.
Metadata	getEndDateMetadata()	Gets the metadata for an end date.
Metadata	getStartDateMetadata()	Gets the metadata for a start date.
void	setEndDate(DateTime date)	Sets the end date.
void	setStartDate(DateTime date)	Sets the start date.

Method Details

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.