org.osid.financials

Interface AccountForm

All Superinterfaces:

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

All Known Subinterfaces:

AccountBatchForm

public interface AccountForm
extends OsidObjectForm, OsidFederateableForm

This is the form for creating and updating Accounts. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the AccountAdminSession. 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	clearCode() Removes the code.
void	clearCreditBalance() Removes the credit balance flag.
AccountFormRecord	getAccountFormRecord(Type accountRecordType) Gets the AccountFormRecord corresponding to the given account record Type.
Metadata	getCodeMetadata() Gets the metadata for the code.
Metadata	getCreditBalanceMetadata() Gets the metadata for the credit balance.
void	setCode(java.lang.String code) Sets the code.
void	setCreditBalance(boolean credit) Sets the credit balance flag.

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

Method Detail

getCreditBalanceMetadata

Metadata getCreditBalanceMetadata()

Gets the metadata for the credit balance.

Returns:

metadata for the credit balance

Compliance:

mandatory - This method must be implemented.

setCreditBalance

void setCreditBalance(boolean credit)

Sets the credit balance flag.

Parameters:

credit - true if credits increase the balance, false if credits decrease the balance

Throws:

InvalidArgumentException - credit is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearCreditBalance

void clearCreditBalance()

Removes the credit balance flag.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getCodeMetadata

Metadata getCodeMetadata()

Gets the metadata for the code.

Returns:

metadata for the code

Compliance:

mandatory - This method must be implemented.

setCode

void setCode(java.lang.String code)

Sets the code.

Parameters:

code - the new code

Throws:

InvalidArgumentException - code is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - code is null

Compliance:

mandatory - This method must be implemented.

clearCode

void clearCode()

Removes the code.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getAccountFormRecord

AccountFormRecord getAccountFormRecord(Type accountRecordType)
                                       throws OperationFailedException

Gets the AccountFormRecord corresponding to the given account record Type.

Parameters:

accountRecordType - an account record type

Returns:

the account form record

Throws:

NullArgumentException - accountRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(accountRecordType) is false

Compliance:

mandatory - This method must be implemented.