com.leonarduk.clearcheckbook.calls

Class AccountCall

java.lang.Object

com.leonarduk.clearcheckbook.calls.AbstractCall<AccountDataType>

com.leonarduk.clearcheckbook.calls.AccountCall

All Implemented Interfaces:

BulkProcessable<AccountDataType>

public class AccountCall
extends AbstractCall<AccountDataType>
implements BulkProcessable<AccountDataType>

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE

Constructor Summary

Constructors

Constructor and Description
AccountCall(ClearCheckBookConnection connection)

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	bulkProcess(List<AccountDataType> dataTypeList) Helper wrapper function to iterate over a list of items to insert/edit/delete calling the relevant method on each.
boolean	delete(ParsedNameValuePair idParameter) Deletes a specific account Method: delete Call: account
boolean	edit(AccountDataType input) Edit the details of an account Method: put Call: account
AccountDataType	get(ParsedNameValuePair id) Returns an array of information for a single account Method: get Call: account
List<AccountDataType>	getAll() Returns an array of all accounts and account balances for this user.
protected String	getUrlSuffix()
String	insert(AccountDataType input) Adds an account to the site Method: post Call: account
String	process(AccountDataType dataType) See AbstractCall.process(AbstractDataType)

Methods inherited from class com.leonarduk.clearcheckbook.calls.AbstractCall

get, getAll, getConnection, getPluralUrl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

AccountCall

public AccountCall(ClearCheckBookConnection connection)

Method Detail

getUrlSuffix

protected String getUrlSuffix()

Specified by:

getUrlSuffix in class AbstractCall<AccountDataType>

bulkProcess

public List<String> bulkProcess(List<AccountDataType> dataTypeList)
                         throws ClearcheckbookException

Description copied from class: AbstractCall

Helper wrapper function to iterate over a list of items to insert/edit/delete calling the relevant method on each.

Specified by:

bulkProcess in interface BulkProcessable<AccountDataType>

Overrides:

bulkProcess in class AbstractCall<AccountDataType>

Returns:

List<String>

Throws:

ClearcheckbookException

process

public String process(AccountDataType dataType)
               throws ClearcheckbookException

Description copied from interface: BulkProcessable

See AbstractCall.process(AbstractDataType)

Specified by:

process in interface BulkProcessable<AccountDataType>

Overrides:

process in class AbstractCall<AccountDataType>

Returns:

Throws:

ClearcheckbookException

getAll

public List<AccountDataType> getAll()
                             throws ClearcheckbookException

Returns an array of all accounts and account balances for this user.
Method: get
Call: accounts

Example:
https://username:password@www.clearcheckbook.com/api/accounts/

Parameters:
Parameter Required Description
is_overview Optional Should be set to "true" if you want to return all accounts that just have a balance (Including transactions not assigned to an account)

Returned Values:
Value Description
id The account id
name the name of the account
type_id the type of account (1= Cash, 2= Checking Account, 3= Savings Account, 4= Credit Card, 5= Investment)
deposit the float value containing the amount of deposits in this account.
jive_deposit the float value containing the amount of jived deposits in this account.
withdrawal the float value containing the amount of withdrawals in this account.
jive_withdrawal the float value containing the amount of jived withdrawals in this account.

Overrides:

getAll in class AbstractCall<AccountDataType>

Returns:

returns a list of accounts.

Throws:

ClearcheckbookException

get

public AccountDataType get(ParsedNameValuePair id)
                    throws ClearcheckbookException

Returns an array of information for a single account
Method: get
Call: account

Example:
https://username:password@www.clearcheckbook.com/api/account/

Parameters: vParameter Required Description
id Required the id of the account you're getting information for

Returned Values:
Value Description
id The account id
name the name of the account
type_id the type of account (1= Cash, 2= Checking Account, 3= Savings Account, 4= Credit Card, 5= Investment)
deposit the float value containing the amount of deposits in this account.
jive_deposit the float value containing the amount of jived deposits in this account.
withdrawal the float value containing the amount of withdrawals in this account.
jive_withdrawal the float value containing the amount of jived withdrawals in this account.

Overrides:

get in class AbstractCall<AccountDataType>

Parameters:

ParsedNameValuePair - id

Returns:

AccountDataType

Throws:

ClearcheckbookException

insert

public String insert(AccountDataType input)
              throws ClearcheckbookException

Adds an account to the site
Method: post
Call: account

Example:
https://username:password@www.clearcheckbook.com/api/account/

Parameters:
Parameter Required Description
name Required The name of the account
type_id Required the type of account (1= Cash, 2= Checking Account, 3= Savings Account, 4= Credit Card, 5= Investment)
initial_balance Optional A float value identifying the existing balance in this account (if negative, put a '-' symbol before the number... -100.00)

Returned Values:
Value Description
Multiple Responses* The newly created id for the account on success or false/null on fail.

Overrides:

insert in class AbstractCall<AccountDataType>

Parameters:

AccountDataType - input

Returns:

id

Throws:

ClearcheckbookException

edit

public boolean edit(AccountDataType input)
             throws ClearcheckbookException

Edit the details of an account
Method: put
Call: account

Example:
https://username:password@www.clearcheckbook.com/api/account/

Parameters:
Parameter Required Description
id Required the id of the account being edited
name Required the new name of the account
type_id Required the new type_id of the account (1= Cash, 2= Checking Account, 3= Savings Account, 4= Credit Card, 5= Investment)

Returned Values:
Value Description
true/false returns true on a successful edit or false on fail.

Overrides:

edit in class AbstractCall<AccountDataType>

Parameters:

AccountDataType - input

Returns:

boolean - ok

Throws:

ClearcheckbookException

delete

public boolean delete(ParsedNameValuePair idParameter)
               throws ClearcheckbookException

Deletes a specific account
Method: delete
Call: account

Example:
https://username:password@www.clearcheckbook.com/api/account/

Parameters:
Parameter Required Description
id Required the id of the account being deleted

Returned Values:
Value Description
true / false returns true upon successfull delete or false/null on fail

Overrides:

delete in class AbstractCall<AccountDataType>

Parameters:

ParsedNameValuePair - idParameter

Returns:

boolean - ok

Throws:

ClearcheckbookException