org.homeunix.thecave.buddi.plugin.api.model
Interface ImmutableAccount

All Superinterfaces:
java.lang.Comparable<ImmutableModelObject>, ImmutableModelObject, ImmutableSource
All Known Subinterfaces:
MutableAccount
All Known Implementing Classes:
ImmutableAccountImpl, MutableAccountImpl

public interface ImmutableAccount
extends ImmutableSource


Method Summary
 Account getAccount()
          Returns the wrapped object from the underlying data model.
 ImmutableAccountType getAccountType()
          Returns the Type object associated with the account.
 long getBalance()
          Returns the current balance of the account.
 long getBalance(java.util.Date d)
          Returns the balance as of the given date.
 long getOverdraftCreditLimit()
          Returns the Overdraft Limit (for debit accounts) or Credit Limit (for credit accounts)
 java.util.Date getStartDate()
          Returns the earliest date assoicated with this source.
 long getStartingBalance()
          Returns the starting balance for the account.
 
Methods inherited from interface org.homeunix.thecave.buddi.plugin.api.model.ImmutableSource
getFullName, getName, getNotes, getSource, isDeleted
 
Methods inherited from interface org.homeunix.thecave.buddi.plugin.api.model.ImmutableModelObject
getModified, getRaw, getUid
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getAccount

Account getAccount()
Returns the wrapped object from the underlying data model. By accessing this method, you bypass all protection which the Buddi API gives you; it is not recommended to use this method unless you understand the risks associated with it.

Returns:

getAccountType

ImmutableAccountType getAccountType()
Returns the Type object associated with the account.

Returns:

getBalance

long getBalance()
Returns the current balance of the account.

Returns:

getBalance

long getBalance(java.util.Date d)
Returns the balance as of the given date.

Parameters:
d -
Returns:

getStartDate

java.util.Date getStartDate()
Returns the earliest date assoicated with this source. This is obtained by looking at the associated transactions / period dates.

Returns:

getStartingBalance

long getStartingBalance()
Returns the starting balance for the account.

Returns:

getOverdraftCreditLimit

long getOverdraftCreditLimit()
Returns the Overdraft Limit (for debit accounts) or Credit Limit (for credit accounts)

Returns: