com.leonarduk.clearcheckbook.calls

Class ReportCall

java.lang.Object

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

com.leonarduk.clearcheckbook.calls.ReportCall

public class ReportCall
extends AbstractCall<ReportDataType>

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE

Constructor Summary

Constructors

Constructor and Description
ReportCall(ClearCheckBookConnection connection)

Method Summary

Methods

Modifier and Type	Method and Description
List<ReportDataType>	getAll() Calls the "get" method from the API that brings back all the values
List<ReportDataType>	getAll(ReportDataType.Type type) Brings back a list of links to graphs in google graph
List<ReportDataType>	getAll(ReportDataType.Type type, int months)
List<ReportDataType>	getAll(ReportDataType.Type type, int months, String bgcolor, int height, int width) Returns an array of images containing reports for the current user Method: get Call: reports
protected String	getUrlSuffix()

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

bulkProcess, delete, edit, get, get, getAll, getConnection, getPluralUrl, insert, 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

ReportCall

public ReportCall(ClearCheckBookConnection connection)

Method Detail

getUrlSuffix

protected String getUrlSuffix()

Specified by:

getUrlSuffix in class AbstractCall<ReportDataType>

getAll

public List<ReportDataType> getAll(ReportDataType.Type type,
                          int months,
                          String bgcolor,
                          int height,
                          int width)
                            throws ClearcheckbookException

Returns an array of images containing reports for the current user
Method: get
Call: reports

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

Parameters:
Parameter Required Description
type Required "pie" or "line". No data will be returned if one of those is not sent.
months Optional Integer value representing the number of months worth of data to use. Default is 6.
bgcolor Optional Background color of the returned image. Send as a color hex code (eg: "F3F3F3"). Default is FFFFFF (white)
height Optional The integer height in pixels of the returned image. Default is 150
width Optional The integer width in pixels of the returned image. Default is 320

Returned Values:
Value Description
label The name of the Account (if type="line") or the date in yyyy-mm-dd format (if type="pie")
url The URL to the image being returned.

Throws:

ClearcheckbookException

getAll

public List<ReportDataType> getAll(ReportDataType.Type type,
                          int months)
                            throws ClearcheckbookException

Throws:

ClearcheckbookException

getAll

public List<ReportDataType> getAll(ReportDataType.Type type)
                            throws ClearcheckbookException

Brings back a list of links to graphs in google graph

Parameters:

type -

Returns:

Throws:

ClearcheckbookException

getAll

public List<ReportDataType> getAll()
                            throws ClearcheckbookException

Description copied from class: AbstractCall

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

Overrides:

getAll in class AbstractCall<ReportDataType>

Returns:

List<extends AbstractDataType>

Throws:

ClearcheckbookException