Order (levelUpCoreLib API)

java.lang.Object
- com.scvngr.levelup.core.model.Order

All Implemented Interfaces:: Parcelable

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

Represents an order.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Order.OrderBuilder
- Nested classes/interfaces inherited from interface android.os.Parcelable
  Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Nested Classes
Modifier and Type	Class and Description
`static class`	`Order.OrderBuilder`

Field Summary

Fields
Modifier and Type Field and Description

static Parcelable.Creator<Order> CREATOR
Implements the Parcelable interface.
- Fields inherited from interface android.os.Parcelable
  CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Fields
Modifier and Type	Field and Description
`static Parcelable.Creator<Order>`	`CREATOR` Implements the `Parcelable` interface.

Constructor Summary

Constructors
Constructor and Description
Order(MonetaryValue balanceAmount, String bundleClosedAt, String bundleDescriptor, MonetaryValue contributionAmount, String contributionTargetName, String createdAt, MonetaryValue creditAppliedAmount, MonetaryValue creditEarnedAmount, String locationExtendedAddress, String locationLocality, String locationName, String locationPostalCode, String locationRegion, String locationStreetAddress, Long locationWebServiceId, String merchantName, Long merchantWebServiceId, String refundedAt, MonetaryValue spendAmount, MonetaryValue tipAmount, MonetaryValue totalAmount, String transactedAt, String uuid)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Order.OrderBuilder`	`builder()`
`int`	`describeContents()`
`boolean`	`equals(Object o)`
`MonetaryValue`	`getBalanceAmount()` The total spent after credit was applied (i.e.: how much was charged to the user's card).
`String`	`getBundleClosedAt()` The time the bundle containing this order closed (or null if it's still open).
`String`	`getBundleDescriptor()` The descriptor (or the best guess at) that this order will show up as on the user's payment statement.
`MonetaryValue`	`getContributionAmount()` The amount contributed to the user's chosen contribution target.
`String`	`getContributionTargetName()` The name of the user's chosen contribution target.
`String`	`getCreatedAt()` The date and time the order was created in the database.
`MonetaryValue`	`getCreditAppliedAmount()` The sum of all credit used to fund the order.
`MonetaryValue`	`getCreditEarnedAmount()` Credit earned by this purchase (e.g.
`String`	`getLocationExtendedAddress()` The order's `Location`'s extended address.
`String`	`getLocationLocality()` The locality (city) of this order's `Location`.
`String`	`getLocationName()` The name of the order's location, if different from the merchant name.
`String`	`getLocationPostalCode()` The postal code for this order's `Location`.
`String`	`getLocationRegion()` The region (state in the US) for this order's `Location`.
`String`	`getLocationStreetAddress()` The address of this order's `Location`.
`Long`	`getLocationWebServiceId()` The web service ID of the `Location` where the order was placed.
`String`	`getMerchantName()` The name of the merchant where the order took place.
`Long`	`getMerchantWebServiceId()` The web service ID of the merchant where this order took place.
`String`	`getRefundedAt()` The timestamp when the order was refunded (if it was refunded).
`MonetaryValue`	`getSpendAmount()` The amount of the transaction before tip.
`MonetaryValue`	`getTipAmount()` The amount the user tipped.
`MonetaryValue`	`getTotalAmount()` Total amount (spend+tip) before any credit was applied.
`String`	`getTransactedAt()` The date and time the user placed the order.
`String`	`getUuid()` The globally-unique ID (UUID) for this order.
`int`	`hashCode()`
`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<Order> CREATOR

Implements the Parcelable interface.

Constructor Detail

Order

public Order(MonetaryValue balanceAmount,
             String bundleClosedAt,
             String bundleDescriptor,
             MonetaryValue contributionAmount,
             String contributionTargetName,
             String createdAt,
             MonetaryValue creditAppliedAmount,
             MonetaryValue creditEarnedAmount,
             String locationExtendedAddress,
             String locationLocality,
             String locationName,
             String locationPostalCode,
             String locationRegion,
             String locationStreetAddress,
             Long locationWebServiceId,
             String merchantName,
             Long merchantWebServiceId,
             String refundedAt,
             MonetaryValue spendAmount,
             MonetaryValue tipAmount,
             MonetaryValue totalAmount,
             String transactedAt,
             String uuid)

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
- builder
```
public static Order.OrderBuilder builder()
```
- getBalanceAmount
```
public MonetaryValue getBalanceAmount()
```
  The total spent after credit was applied (i.e.: how much was charged to the user's card).
- getBundleClosedAt
```
public String getBundleClosedAt()
```
  The time the bundle containing this order closed (or null if it's still open).
- getBundleDescriptor
```
public String getBundleDescriptor()
```
  The descriptor (or the best guess at) that this order will show up as on the user's payment statement.
- getContributionAmount
```
public MonetaryValue getContributionAmount()
```
  The amount contributed to the user's chosen contribution target.
- getContributionTargetName
```
public String getContributionTargetName()
```
  The name of the user's chosen contribution target.
- getCreatedAt
```
public String getCreatedAt()
```
  The date and time the order was created in the database. See transactedAt for the date and time the order was placed.
- getCreditAppliedAmount
```
public MonetaryValue getCreditAppliedAmount()
```
  The sum of all credit used to fund the order.
- getCreditEarnedAmount
```
public MonetaryValue getCreditEarnedAmount()
```
  Credit earned by this purchase (e.g. the user unlocked loyalty).
- getLocationExtendedAddress
```
public String getLocationExtendedAddress()
```
  The order's Location's extended address.
- getLocationLocality
```
public String getLocationLocality()
```
  The locality (city) of this order's Location.
- getLocationName
```
public String getLocationName()
```
  The name of the order's location, if different from the merchant name.
- getLocationPostalCode
```
public String getLocationPostalCode()
```
  The postal code for this order's Location.
- getLocationRegion
```
public String getLocationRegion()
```
  The region (state in the US) for this order's Location.
- getLocationStreetAddress
```
public String getLocationStreetAddress()
```
  The address of this order's Location.
- getLocationWebServiceId
```
public Long getLocationWebServiceId()
```
  The web service ID of the Location where the order was placed.
- getMerchantName
```
public String getMerchantName()
```
  The name of the merchant where the order took place.
- getMerchantWebServiceId
```
public Long getMerchantWebServiceId()
```
  The web service ID of the merchant where this order took place.
- getRefundedAt
```
public String getRefundedAt()
```
  The timestamp when the order was refunded (if it was refunded).
- getSpendAmount
```
public MonetaryValue getSpendAmount()
```
  The amount of the transaction before tip.
- getTipAmount
```
public MonetaryValue getTipAmount()
```
  The amount the user tipped.
- getTotalAmount
```
public MonetaryValue getTotalAmount()
```
  Total amount (spend+tip) before any credit was applied.
- getTransactedAt
```
public String getTransactedAt()
```
  The date and time the user placed the order.
- getUuid
```
public String getUuid()
```
  The globally-unique ID (UUID) for this order.
- 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

Class Order

Nested Class Summary

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

Field Summary

Fields inherited from interface android.os.Parcelable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CREATOR

Constructor Detail

Order

Method Detail

describeContents

writeToParcel

builder

getBalanceAmount

getBundleClosedAt

getBundleDescriptor

getContributionAmount

getContributionTargetName

getCreatedAt

getCreditAppliedAmount

getCreditEarnedAmount

getLocationExtendedAddress

getLocationLocality

getLocationName

getLocationPostalCode

getLocationRegion

getLocationStreetAddress

getLocationWebServiceId

getMerchantName

getMerchantWebServiceId

getRefundedAt

getSpendAmount

getTipAmount

getTotalAmount

getTransactedAt

getUuid

equals

hashCode

toString