public interface Account extends OsidObject, Federateable
An Account
represents a general ledger account.
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.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
boolean isCreditBalance()
true
if credits increase the balance,
false
if credits decrease the balancemandatory
- This method must be implemented. java.lang.String getCode()
mandatory
- This method must be implemented. AccountRecord getAccountRecord(Type accountRecordType) throws OperationFailedException
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
.accountRecordType
- the type of account record to retrieveNullArgumentException
- accountRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(accountRecordType)
is false
mandatory
- This method must be implemented.