com.leonarduk.clearcheckbook.calls

Class ReminderCall

java.lang.Object

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

com.leonarduk.clearcheckbook.calls.ReminderCall

public class ReminderCall
extends AbstractCall<ReminderDataType>

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE

Constructor Summary

Constructors

Constructor and Description
ReminderCall(ClearCheckBookConnection connection)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	delete(ParsedNameValuePair input) Delete a single occurrence of a reminder for the current user.
boolean	deleteAll(ParsedNameValuePair id) Delete all occurrences of a reminder for the current user.
boolean	edit(ReminderDataType dataType) Edit a specific reminder for the current user.
ReminderDataType	get(ParsedNameValuePair id) Returns information about a specific reminder.
List<ReminderDataType>	getAll() Returns an array of reminders for the current user Method: get Call: reminders
protected String	getUrlSuffix()
String	insert(ReminderDataType input) Inserts a reminder for the current user Method: post Call: reminder

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

bulkProcess, get, getAll, getConnection, getPluralUrl, process

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

ReminderCall

public ReminderCall(ClearCheckBookConnection connection)

Method Detail

getUrlSuffix

protected String getUrlSuffix()

Specified by:

getUrlSuffix in class AbstractCall<ReminderDataType>

getAll

public List<ReminderDataType> getAll()
                              throws ClearcheckbookException

Returns an array of reminders for the current user
Method: get
Call: reminders

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

Parameters:
Parameter Required Description
upcoming_days Optional The number of days worth of reminders you would like to receive. Default = 30

Returned Values:
Value Description
reminder_id the id of the reminder in the ClearCheckbook system
date the next date this reminder is set to occur on
reminder_date_id the id of the date in the ClearCheckbook system
title the title of the reminder
start_date the date the reminder is set to start
end_date the date the reminder is set to end
notify 0 or 1. 1 if the user selected to be emailed before the reminder occurs.
notify_time 0-7. The number of days ahead of the reminder the user would like to be emailed
repeat 0 or 1. 1 if this reminder is set to repeat
repeat_every_num Integer for how often this should repeat. If set to 2 and repeat_every = 3, this reminder will repeat every 2 months.
repeat_every 1-4. 1=Day, 2=Week, 3=Month, 4=Year
floats 0 or 1. 1 if this reminder is set to float
floats_every_num When this reminder floats. 1= First, 2= Second, 3= Third, 4= Fourth, -1= Last
floats_every When this reminder floats. 0= Sunday, 1= Monday, 2= Tuesday, 3= Wednesday, 4= Thursday, 5= Friday, 6= Saturday, -1= Day
trans_amount If there is a recurring transaction associated with this reminder, this is the amount
trans_description If there is a recurring transaction associated with this reminder, this is the description
trans_transaction_type If there is a recurring transaction associated with this reminder, this is the transaction type (0=withdrawal, 1=deposit, 3= transfer)
trans_account_id If there is a recurring transaction associated with this reminder, this is the account_id
trans_category_id If there is a recurring transaction associated with this reminder, this is the category_id
trans_transfertoaccount If there is a recurring transaction associated with this reminder, this is the account_id of the account being transferred to
trans_check_num If there is a recurring transaction associated with this reminder, this is the check_num
trans_memo If there is a recurring transaction associated with this reminder, this is the memo
trans_payee If there is a recurring transaction associated with this reminder, this is the payee

Overrides:

getAll in class AbstractCall<ReminderDataType>

Returns:

List<extends AbstractDataType>

Throws:

ClearcheckbookException

get

public ReminderDataType get(ParsedNameValuePair id)
                     throws ClearcheckbookException

Returns information about a specific reminder.
Method: get
Call: reminder

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

Parameters:
Parameter Required Description
id Required The id of the reminder you want

Returned Values:
Value Description
id the id of the reminder in the ClearCheckbook system
title the title of the reminder
start_date the date the reminder is set to start
end_date the date the reminder is set to end
notify 0 or 1. 1 if the user selected to be emailed before the reminder occurs.
notify_time 0-7. The number of days ahead of the reminder the user would like to be emailed
repeat 0 or 1. 1 if this reminder is set to repeat
repeat_every_num Integer for how often this should repeat. If set to 2 and repeat_every = 3, this reminder will repeat every 2 months.
repeat_every 1-4. 1=Day, 2=Week, 3=Month, 4=Year
floats 0 or 1. 1 if this reminder is set to float
floats_every_num When this reminder floats. 1= First, 2= Second, 3= Third, 4= Fourth, -1= Last
floats_every When this reminder floats. 0= Sunday, 1= Monday, 2= Tuesday, 3= Wednesday, 4= Thursday, 5= Friday, 6= Saturday, -1= Day
trans_amount If there is a recurring transaction associated with this reminder, this is the amount
trans_description If there is a recurring transaction associated with this reminder, this is the description
trans_transaction_type If there is a recurring transaction associated with this reminder, this is the transaction type (0=withdrawal, 1=deposit, 3= transfer)
trans_account_id If there is a recurring transaction associated with this reminder, this is the account_id
trans_category_id If there is a recurring transaction associated with this reminder, this is the category_id
trans_transfertoaccount If there is a recurring transaction associated with this reminder, this is the account_id of the account being transferred to
trans_check_num If there is a recurring transaction associated with this reminder, this is the check_num
trans_memo If there is a recurring transaction associated with this reminder, this is the memo
trans_payee If there is a recurring transaction associated with this reminder, this is the payee

Overrides:

get in class AbstractCall<ReminderDataType>

Returns:

extends AbstractDataType

Throws:

ClearcheckbookException

insert

public String insert(ReminderDataType input)
              throws ClearcheckbookException

Inserts a reminder for the current user
Method: post
Call: reminder

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

Parameters:
Parameter Required Description
title Required The title of the reminder
email Required "true" or "false". "true" if you want to this email to remind the user
emailDays Optional If email is set to "true", this is the number of days ahead of time the user will be emailed (1-7)
start_year Required the year of the start date (YYYY)
start_month Required the month of the start date (MM)
start_day Required the day of the start date (DD)
end_year Optional the year of the end date (YYYY)
end_month Optional the month of the end date (MM)
end_day Optional the day of the end date (DD)
occur_once Optional "true" if this reminder is only occuring once.
occur_repeating Optional "true" if this reminder is repeating
occur_floating Optional "true" if this reminder is floating
repeat_every Optional 1-4. 1=Day, 2=Week, 3=Month, 4=Year
repeat_every_num Optional Integer for how often this should repeat. If set to 2 and repeat_every = 3, this reminder will repeat every 2 months.
float_every Optional When this reminder floats. 0= Sunday, 1= Monday, 2= Tuesday, 3= Wednesday, 4= Thursday, 5= Friday, 6= Saturday, -1= Day
float_every_num Optional When this reminder floats. 1= First, 2= Second, 3= Third, 4= Fourth, -1= Last
transaction Required "true" or "false". "true" if there is a transaction associated with this reminder.
trans_amount Optional The amount associated with the transaction
trans_description Optional the description associated with the transaction
trans_payee Optional the payee associated with this transaction
trans_memo Optional the memo associated with this transaction
trans_check_num Optional the check number associated with this transaction
trans_account_id Optional the account_id associated with this transaction
trans_category_id Optional the category_id associated with this transaction
trans_transaction_type Optional The transaction type associated with this transaction. (0=withdrawal, 1=deposit, 3= transfer)
trans_accountFrom Optional If trans_transaction_type = 3, this is the account_id you're transferring from
trans_accountTo Optional If trans_transaction_type = 3, this is the account_id you're transferring to

Returned Values:
Value Description
id / false Returns the id of the newly created reminder or false/null on fail

Overrides:

insert in class AbstractCall<ReminderDataType>

Returns:

String if successful, returns the id, else throws exception

Throws:

ClearcheckbookException

edit

public boolean edit(ReminderDataType dataType)
             throws ClearcheckbookException

Edit a specific reminder for the current user.
Method: put
Call: reminder

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

Parameters:
Parameter Required Description
reminder_id Required The id of the reminder being edited.
title Required The title of the reminder
email Required "true" or "false". "true" if you want to this email to remind the user
emailDays Optional If email is set to "true", this is the number of days ahead of time the user will be emailed (1-7)
start_year Required the year of the start date (YYYY)
start_month Required the month of the start date (MM)
start_day Required the day of the start date (DD)
end_year Optional the year of the end date (YYYY)
end_month Optional the month of the end date (MM)
end_day Optional the day of the end date (DD)
occur_once Optional "true" if this reminder is only occuring once.
occur_repeating Optional "true" if this reminder is repeating
occur_floating Optional "true" if this reminder is floating
repeat_every Optional 1-4. 1=Day, 2=Week, 3=Month, 4=Year
repeat_every_num Optional Integer for how often this should repeat. If set to 2 and repeat_every = 3, this reminder will repeat every 2 months.
float_every Optional When this reminder floats. 0= Sunday, 1= Monday, 2= Tuesday, 3= Wednesday, 4= Thursday, 5= Friday, 6= Saturday, -1= Day
float_every_num Optional When this reminder floats. 1= First, 2= Second, 3= Third, 4= Fourth, -1= Last
transaction Required "true" or "false". "true" if there is a transaction associated with this reminder.
trans_amount Optional The amount associated with the transaction
trans_description Optional the description associated with the transaction
trans_payee Optional the payee associated with this transaction
trans_memo Optional the memo associated with this transaction
trans_check_num Optional the check number associated with this transaction
trans_account_id Optional the account_id associated with this transaction
trans_category_id Optional the category_id associated with this transaction
trans_transaction_type Optional The transaction type associated with this transaction. (0=withdrawal, 1=deposit, 3= transfer)
trans_accountFrom Optional If trans_transaction_type = 3, this is the account_id you're transferring from
trans_accountTo Optional If trans_transaction_type = 3, this is the account_id you're transferring to

Returned Values:
Value Description
true / false Returns true on a successful edit or false/null on fail. NB - this appears to change the id so you cannot do edit (id) then get(id) as the id will change

Overrides:

edit in class AbstractCall<ReminderDataType>

Returns:

boolean - true means edit was successful

Throws:

ClearcheckbookException

delete

public boolean delete(ParsedNameValuePair input)
               throws ClearcheckbookException

Delete a single occurrence of a reminder for the current user.
Method: delete
Call: reminder

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

Parameters:
Parameter Required Description
id Required The id of the reminder to delete

Returned Values:
Value Description
true / false Returns true on a successful delete or false/null on fail

Overrides:

delete in class AbstractCall<ReminderDataType>

Returns:

boolean - true means delete was successful

Throws:

ClearcheckbookException

deleteAll

public boolean deleteAll(ParsedNameValuePair id)
                  throws ClearcheckbookException

Delete all occurrences of a reminder for the current user.
Method: delete
Call: reminders

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

Parameters:
Parameter Required Description
id Required The id of the reminder to delete

Returned Values:
Value Description
true / false Returns true on a successful delete or false/null on fail

Returns:

Throws:

ClearcheckbookException