com.leonarduk.clearcheckbook.calls

Class PremiumCall

java.lang.Object

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

com.leonarduk.clearcheckbook.calls.PremiumCall

public class PremiumCall
extends AbstractCall<PremiumDataType>

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE

Constructor Summary

Constructors

Constructor and Description
PremiumCall(ClearCheckBookConnection connection)

Method Summary

Methods

Modifier and Type	Method and Description
PremiumDataType	get() Determines whether or not this user is a premium member.
protected String	getUrlSuffix()

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

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

PremiumCall

public PremiumCall(ClearCheckBookConnection connection)

Method Detail

getUrlSuffix

protected String getUrlSuffix()

Specified by:

getUrlSuffix in class AbstractCall<PremiumDataType>

get

public PremiumDataType get()
                    throws ClearcheckbookException

Determines whether or not this user is a premium member. If they are, it returns their custom field flags.
Method: get
Call: premium

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

Parameters:
Parameter Required Description
None

Returned Values:
Value Description
status true or false. true if the user has a valid premium membership
check_num 0 or 1. 1 if the user has the additional check number field enabled
memo 0 or 1. 1 if the user has the additional memo field enabled
payee 0 or 1. 1 if the user has the additional payee field enabled

Overrides:

get in class AbstractCall<PremiumDataType>

Returns:

extends AbstractDataType

Throws:

ClearcheckbookException