com.leonarduk.clearcheckbook.calls

Class CategoryCall

java.lang.Object

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

com.leonarduk.clearcheckbook.calls.CategoryCall

public class CategoryCall
extends AbstractCall<CategoryDataType>

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE

Constructor Summary

Constructors

Constructor and Description
CategoryCall(ClearCheckBookConnection connection)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	delete(ParsedNameValuePair id) Deletes a specific category for the current user Method: delete Call: category
boolean	edit(CategoryDataType input) Edit a specific category for the current user.
List<CategoryDataType>	getAll() Gets all of the current users categories Method: get Call: categories
protected String	getPluralUrl()
protected String	getUrlSuffix()
String	insert(CategoryDataType input) Adds a category to the current users accout.

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

bulkProcess, get, get, getAll, getConnection, 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

CategoryCall

public CategoryCall(ClearCheckBookConnection connection)

Method Detail

getUrlSuffix

protected String getUrlSuffix()

Specified by:

getUrlSuffix in class AbstractCall<CategoryDataType>

getPluralUrl

protected String getPluralUrl()

Overrides:

getPluralUrl in class AbstractCall<CategoryDataType>

delete

public boolean delete(ParsedNameValuePair id)
               throws ClearcheckbookException

Deletes a specific category for the current user
Method: delete
Call: category

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

Parameters: Parameter Required Description
id Required The id of the category being deleted

Returned Values:
Value Description
true / false Returns true upon removal of the category or false/null on fail

Overrides:

delete in class AbstractCall<CategoryDataType>

Returns:

Throws:

ClearcheckbookException

edit

public boolean edit(CategoryDataType input)
             throws ClearcheckbookException

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

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

Parameters:
Parameter Required Description
id Required The id of the category being edited
name Required The new name for the category
parent Required The new parent id for the category

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

Overrides:

edit in class AbstractCall<CategoryDataType>

Returns:

Throws:

ClearcheckbookException

getAll

public List<CategoryDataType> getAll()
                              throws ClearcheckbookException

Gets all of the current users categories
Method: get
Call: categories

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

Parameters:
Parameter Required Description
None

Returned Values:
Value Description
id The id of the category
name The name of the category
parent The id of this category's parent. 0 if there is no parent.

Overrides:

getAll in class AbstractCall<CategoryDataType>

Returns:

Throws:

ClearcheckbookException

insert

public String insert(CategoryDataType input)
              throws ClearcheckbookException

Adds a category to the current users accout.
Method: post
Call: category

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

Parameters:
Parameter Required Description
name Required The name of the new category
parent Optional The id of this category's parent.

Returned Values:
Value Description
id / false The id of the newly created category or false/null on fail.

Overrides:

insert in class AbstractCall<CategoryDataType>

Returns:

Throws:

ClearcheckbookException