com.scvngr.levelup.core.model

Class Loyalty

java.lang.Object

com.scvngr.levelup.core.model.Loyalty

All Implemented Interfaces:

Parcelable

@Immutable
 @LevelUpApi(contract=PUBLIC)
public final class Loyalty
extends Object
implements Parcelable

Represents a Loyalty progression at a merchant for a user on the server.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static Parcelable.Creator<Loyalty>	CREATOR Implements the Parcelable interface.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
Loyalty(boolean isLoyaltyEnabled, Long merchantWebServiceId, int ordersCount, MonetaryValue potentialCredit, int progressPercentage, MonetaryValue savings, MonetaryValue shouldSpend, MonetaryValue spendRemaining, MonetaryValue totalVolume, MonetaryValue willEarn)

Method Summary

Modifier and Type	Method and Description
int	describeContents()
boolean	equals(Object o)
Long	getMerchantWebServiceId() The web service ID of merchant for this loyalty.
int	getOrdersCount() The number of orders the user has at the merchant.
MonetaryValue	getPotentialCredit() The potential credit the user can spend at the merchant.
int	getProgressPercentage() The percentage of the user's progress to the next loyalty unlock.
MonetaryValue	getSavings() The total savings the user has had at the merchant.
MonetaryValue	getShouldSpend() The amount any user must spend to unlock loyalty at the merchant.
MonetaryValue	getSpendRemaining() The amount the user still has to spend before unlocking loyalty.
MonetaryValue	getTotalVolume() The total amount the user has spent at the merchant.
MonetaryValue	getWillEarn() The amount the user will earn once they unlock the loyalty reward.
int	hashCode()
boolean	isLoyaltyEnabled() If Loyalty progression is enabled.
String	toString()
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CREATOR

public static final Parcelable.Creator<Loyalty> CREATOR

Implements the Parcelable interface.

Constructor Detail

Loyalty

public Loyalty(boolean isLoyaltyEnabled,
               Long merchantWebServiceId,
               int ordersCount,
               MonetaryValue potentialCredit,
               int progressPercentage,
               MonetaryValue savings,
               MonetaryValue shouldSpend,
               MonetaryValue spendRemaining,
               MonetaryValue totalVolume,
               MonetaryValue willEarn)

Method Detail

describeContents

public int describeContents()

Specified by:

describeContents in interface Parcelable

writeToParcel

public void writeToParcel(Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface Parcelable

isLoyaltyEnabled

public boolean isLoyaltyEnabled()

If Loyalty progression is enabled.

getMerchantWebServiceId

public Long getMerchantWebServiceId()

The web service ID of merchant for this loyalty.

getOrdersCount

public int getOrdersCount()

The number of orders the user has at the merchant.

getPotentialCredit

public MonetaryValue getPotentialCredit()

The potential credit the user can spend at the merchant.

getProgressPercentage

public int getProgressPercentage()

The percentage of the user's progress to the next loyalty unlock.

getSavings

public MonetaryValue getSavings()

The total savings the user has had at the merchant.

getShouldSpend

public MonetaryValue getShouldSpend()

The amount any user must spend to unlock loyalty at the merchant.

getSpendRemaining

public MonetaryValue getSpendRemaining()

The amount the user still has to spend before unlocking loyalty.

getTotalVolume

public MonetaryValue getTotalVolume()

The total amount the user has spent at the merchant.

getWillEarn

public MonetaryValue getWillEarn()

The amount the user will earn once they unlock the loyalty reward.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object