org.osid.financials

Interface Account

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidObject

public interface Account
extends OsidObject, Federateable

An Account represents a general ledger account.

Method Summary

Methods

Modifier and Type	Method and Description
AccountRecord	getAccountRecord(Type accountRecordType) Gets the account record corresponding to the given Account record Type.
java.lang.String	getCode() Gets a code for this G/L account.
boolean	isCreditBalance() Tests if this account is a credit or debit account.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

isCreditBalance

boolean isCreditBalance()

Tests if this account is a credit or debit account.

Returns:

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

Compliance:

mandatory - This method must be implemented.

getCode

java.lang.String getCode()

Gets a code for this G/L account.

Returns:

an account code

Compliance:

mandatory - This method must be implemented.

getAccountRecord

AccountRecord getAccountRecord(Type accountRecordType)
                               throws OperationFailedException

Gets the account record corresponding to the given Account record Type. This method is used to retrieve an object implementing the requested record. The accountRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(accountRecordType) is true .

Parameters:

accountRecordType - the type of account record to retrieve

Returns:

the account record

Throws:

NullArgumentException - accountRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(accountRecordType) is false

Compliance:

mandatory - This method must be implemented.