org.osid.financials.batch

Interface ActivityBatchForm

All Superinterfaces:

ActivityForm, Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidFederateableForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidTemporalForm, Suppliable

public interface ActivityBatchForm
extends ActivityForm

This is the form for creating and updating activities in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ActivityBatchAdminSession. 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
void	clearParents() Removes the hierarchical parents.
Id	getAccountId() Gets the account Id of the activity if this is a create transaction.
Metadata	getParentsMetadata() Gets the metadata for setting the hierarchical parents of this business.
void	setParents(Id[] parents) Sets the hierarchical parents.

Methods inherited from interface org.osid.financials.ActivityForm

clearCode, clearOrganization, clearSupervisor, getActivityFormRecord, getCodeMetadata, getOrganizationMetadata, getSupervisorMetadata, setCode, setOrganization, setSupervisor

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

getAccountId

Id getAccountId()

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

Returns:

the account Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getParentsMetadata

Metadata getParentsMetadata()

Gets the metadata for setting the hierarchical parents of this business.

Returns:

metadata for the parents

Compliance:

mandatory - This method must be implemented.

setParents

void setParents(Id[] parents)

Sets the hierarchical parents.

Parameters:

parents - the new parents

Throws:

InvalidArgumentException - parents is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - parents is null

Compliance:

mandatory - This method must be implemented.

clearParents

void clearParents()

Removes the hierarchical parents.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.