com.leonarduk.clearcheckbook.calls

Class AbstractCall<T extends AbstractDataType<?>>

java.lang.Object

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

Type Parameters:

T -

Direct Known Subclasses:

AccountCall, CategoryCall, LimitCall, PremiumCall, ReminderCall, ReportCall, TransactionCall, UserCall

public abstract class AbstractCall<T extends AbstractDataType<?>>
extends Object

Abstract template class to hold the main processing shared by the API calls. Methods are protected scope to be overriden by a public scope version in concrete child class.

Since:

29 Jan 2014

Version:

$Author:: $: Author of last commit, $Rev:: $: Revision of last commit, $Date:: $: Date of last commit

Author:

Stephen Leonard

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCall(ClearCheckBookConnection connection, Class<T> dataTypeClass)

Method Summary

Methods

Modifier and Type	Method and Description
protected List<String>	bulkProcess(List<T> dataTypeList) Helper wrapper function to iterate over a list of items to insert/edit/delete calling the relevant method on each.
protected boolean	delete(ParsedNameValuePair id)
protected boolean	edit(T input)
protected T	get()
protected T	get(ParsedNameValuePair id) Calls the "get" method from the API that brings back the item by id
protected List<T>	getAll() Calls the "get" method from the API that brings back all the values
protected List<T>	getAll(ParsedNameValuePair... parameters) Calls the "get" method from the API that brings back all the values
ClearCheckBookConnection	getConnection()
protected String	getPluralUrl()
protected abstract String	getUrlSuffix()
protected String	insert(T input)
protected String	process(T dataType)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCall

protected AbstractCall(ClearCheckBookConnection connection,
            Class<T> dataTypeClass)

Method Detail

getUrlSuffix

protected abstract String getUrlSuffix()

getPluralUrl

protected String getPluralUrl()

get

protected T get(ParsedNameValuePair id)
                                     throws ClearcheckbookException

Calls the "get" method from the API that brings back the item by id

Parameters:

id -

Returns:

extends AbstractDataType

Throws:

IOException

ClearcheckbookException

get

protected T get()
                                     throws ClearcheckbookException

Returns:

extends AbstractDataType

Throws:

ClearcheckbookException

getAll

protected List<T> getAll()
                                              throws ClearcheckbookException

Calls the "get" method from the API that brings back all the values

Parameters:

parameters -

Returns:

List<extends AbstractDataType>

Throws:

ClearcheckbookException

getAll

protected List<T> getAll(ParsedNameValuePair... parameters)
                                              throws ClearcheckbookException

Calls the "get" method from the API that brings back all the values

Parameters:

parameters -

Returns:

List<extends AbstractDataType>

Throws:

ClearcheckbookException

bulkProcess

protected List<String> bulkProcess(List<T> dataTypeList)
                            throws ClearcheckbookException

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

Returns:

List<String>

Throws:

ClearcheckbookException

process

protected String process(T dataType)
                  throws ClearcheckbookException

Throws:

ClearcheckbookException

insert

protected String insert(T input)
                 throws ClearcheckbookException

Parameters:

input -

Returns:

String if successful, returns the id, else throws exception

Throws:

ClearcheckbookException

edit

protected boolean edit(T input)
                throws ClearcheckbookException

Parameters:

input -

Returns:

boolean - true means edit was successful

Throws:

ClearcheckbookException

delete

protected boolean delete(ParsedNameValuePair id)
                  throws ClearcheckbookException

Parameters:

input -

Returns:

boolean - true means delete was successful

Throws:

ClearcheckbookException

getConnection

public ClearCheckBookConnection getConnection()

Returns:

the connection