Package com.cheetahdigital.punchcards.core.api

Class PunchcardAPI

java.lang.Object

com.cheetahdigital.corekit.models.module.Controller

com.cheetahdigital.punchcards.core.api.PunchcardAPI

All Implemented Interfaces:

RestController

public class PunchcardAPI
extends Controller

Cheetah Loyalty Punchcard Module A Punchcard represents one User Activity.

Field Summary

Fields inherited from class com.cheetahdigital.corekit.models.module.Controller

STANDARD_DATE_FORMAT, TIMEZONE_DATE_FORMAT

Constructor Summary

Constructors

Constructor	Description
PunchcardAPI()

Method Summary

Modifier and Type	Method	Description
void	getPunchcard(PunchcardParams punchcardParams, boolean clearCache, ListenerModel<BaseModel<Punchcard>,Punchcard> listener)	Gets a specific punchcard using id or name
void	getPunchcardInstance(PunchcardParams punchcardParams, boolean clearCache, ListenerModel<BaseModel<PunchcardInstance>,PunchcardInstance> listener)	Gets the specific punchcard instance of a member
void	getPunchcardInstanceList(PunchcardParams punchcardParams, boolean clearCache, ListenerModel<BaseModel<PunchcardInstanceList>,PunchcardInstanceList> listener)	Gets the list of a member's punchcard instances
void	getPunchcardList(PunchcardParams punchcardParams, boolean clearCache, ListenerModel<BaseModel<PunchcardList>,PunchcardList> listener)	Gets the list of published punchcards
void	punch(PunchcardParams punchcardParams, ListenerModel<BaseModel<PunchcardInstance>,PunchcardInstance> listener)	Gives a punch for a punchcard

Methods inherited from class com.cheetahdigital.corekit.models.module.Controller

createCache, createHttpClient, createRetrofitInterface, evictAllCache, getGsonConfiguration, getRestAdapter, getTimeoutConnectionInSeconds, getTimeoutSocketInSeconds, initialize, removeResponsesFromCache

Methods inherited from class java.lang.Object

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

Constructor Detail

PunchcardAPI

public PunchcardAPI()

Method Detail

getPunchcardList

public void getPunchcardList(@NonNull
                             PunchcardParams punchcardParams,
                             boolean clearCache,
                             @NonNull
                             ListenerModel<BaseModel<PunchcardList>,PunchcardList> listener)

Gets the list of published punchcards

Parameters:

punchcardParams - the PunchcardParams for Punchcard API

clearCache - set to true to clear previously stored cache

listener - callback to handle the results

getPunchcard

public void getPunchcard(@NonNull
                         PunchcardParams punchcardParams,
                         boolean clearCache,
                         @NonNull
                         ListenerModel<BaseModel<Punchcard>,Punchcard> listener)

Gets a specific punchcard using id or name

Parameters:

punchcardParams - the for Punchcard API

clearCache - set to true to clear previously stored cache

listener - callback to handle the results

getPunchcardInstanceList

public void getPunchcardInstanceList(@NonNull
                                     PunchcardParams punchcardParams,
                                     boolean clearCache,
                                     @NonNull
                                     ListenerModel<BaseModel<PunchcardInstanceList>,PunchcardInstanceList> listener)

Gets the list of a member's punchcard instances

Parameters:

punchcardParams - the PunchcardParams for Punchcard API

clearCache - set to true to clear previously stored cache

listener - callback to handle the results

getPunchcardInstance

public void getPunchcardInstance(@NonNull
                                 PunchcardParams punchcardParams,
                                 boolean clearCache,
                                 @NonNull
                                 ListenerModel<BaseModel<PunchcardInstance>,PunchcardInstance> listener)

Gets the specific punchcard instance of a member

Parameters:

punchcardParams - the PunchcardParams for Punchcard API

clearCache - set to true to clear previously stored cache

listener - callback to handle the results

punch

public void punch(@NonNull
                  PunchcardParams punchcardParams,
                  @NonNull
                  ListenerModel<BaseModel<PunchcardInstance>,PunchcardInstance> listener)

Gives a punch for a punchcard

Parameters:

punchcardParams - the PunchcardParams for Punchcard API

listener - callback to handle the results