Interface Account

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidObject

public interface Account
extends OsidObject, Federateable

An Account represents a general ledger account.

Method Summary

Modifier and Type	Method	Description
AccountRecord	getAccountRecord(Type accountRecordType)	Gets the account record corresponding to the given Account record Type .This method is used to retrieve an object implementing the requested record.
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 Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Modifier and Type	Method	Description
DisplayText	getDescription()	Gets the description associated with this instance of this OSID object.
DisplayText	getDisplayName()	Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.
Type	getGenusType()	Gets the genus type of this object.
boolean	isOfGenusType(Type genusType)	Tests if this object is of the given genus Type .

Method Details

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

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.