All Implemented Interfaces:: android.os.Parcelable , java.io.Serializable


public class MenigaOffer
 implements Parcelable, Serializable

Field Summary

Fields
Modifier and Type	Field	Description
`protected long`	`id`
`protected String`	`title`
`protected String`	`description`
`protected Long`	`brandId`
`protected String`	`brandName`
`protected String`	`validationToken`
`protected OfferState`	`state`
`protected RewardType`	`rewardType`
`protected MenigaDecimal`	`reward`
`protected MenigaDecimal`	`totalRedeemedAmount`
`protected MenigaDecimal`	`minimumPurchaseAmount`
`protected MenigaDecimal`	`maximumRedemptionPerOffer`
`protected MenigaDecimal`	`maximumRedemptionPerPurchase`
`protected MenigaDecimal`	`minimumAccumulatedAmount`
`protected Integer`	`maximumPurchase`
`protected MenigaDecimal`	`lastReimbursementAmount`
`protected DateTime`	`lastReimbursementDate`
`protected MenigaDecimal`	`scheduledReimbursementAmount`
`protected DateTime`	`scheduledReimbursementDate`
`protected int`	`daysLeft`
`protected DateTime`	`validFrom`
`protected DateTime`	`validTo`
`protected DateTime`	`activatedDate`
`protected DateTime`	`declineDate`
`protected String`	`merchantName`
`protected RelevanceHookDisplay`	`relevanceHook`
`protected MenigaDecimal`	`totalSpendingAtSimilarBrands`
`protected MenigaDecimal`	`totalSpendingOnOffer`
`protected MenigaDecimal`	`offerSimilarBrandsSpendingRatio`
`protected List<MenigaOfferMerchantLocation>`	`merchantLocations`
`protected String`	`webUri`
`protected String`	`webUriLabel`
`public final static Parcelable.Creator<MenigaOffer>`	`CREATOR`

Method Summary

Modifier and Type	Method	Description
`static void`	`setOperator(MenigaOfferOperations operator)`	Sets the api operator for doing api calls
`boolean`	`isMerchantDeclined()`
`boolean`	`isActivateOfferOnFirstPurchase()`
`boolean`	`equals(Object o)`
`int`	`hashCode()`
`static Result<MenigaOfferPage>`	`fetch(int skip, int take, List<OfferFilterState> states, List<Long> offerIds, boolean expiredWithRedemptionOnly)`	Returns offers and relevant meta data.
`static Result<MenigaOffer>`	`fetch(long id)`	Returns offer with specific id
`static Result<MenigaOffer>`	`fetch(String validationToken)`	Returns offer with specific validation token
`static Result<MenigaOfferPage>`	`fetch(List<OfferFilterState> states)`	Returns offers and relevant meta data.
`static Result<MenigaOfferPage>`	`fetchId(List<Long> offerIds)`	Returns offers and relevant meta data by specific ids
`static Result<MenigaOfferPage>`	`fetch(int skip, int take)`	Returns offers and relevant meta data
`Result<Void>`	`activate()`	Activate offer by offer id
`Result<Void>`	`activateByToken()`	Activate offer by offer by validation token
`static Result<Void>`	`activateByToken(String validationToken)`
`static Result<Void>`	`seen(long offerId)`	Mark offer as seen
`Result<Void>`	`decline()`	Decline offer
`Result<Void>`	`markAsSeen()`	Mark offer as seen
`Result<MenigaSimilarBrandSpendingDetails>`	`fetchSimilarBrandSpendingDetails()`	Fetch similar brand spending details
`static Result<MenigaSimilarBrandSpendingDetails>`	`fetchSimilarBrandSpendingDetailsById(int id)`	Fetch similar brand spending details by offer id
`Result<MenigaRedemptions>`	`fetchRedemptions()`	Fetch redemption transactions
`static Result<MenigaRedemptions>`	`fetchRedemptionsById(int id)`	Fetch redemption transactions by offer id
`Result<MenigaOfferMerchantLocationPage>`	`fetchNearbyMerchantLocations(Double latitude, Double longitude, Double radiumKm, Integer limitLocations)`	Fetch nearby merchant locations
`static Result<MenigaOfferMerchantLocationPage>`	`fetchNearbyMerchantLocationsById(int id, Double latitude, Double longitude, Double radiumKm, Integer limitLocations)`	Fetch nearby merchant locations by offer id
`int`	`describeContents()`
`void`	`writeToParcel(Parcel dest, int flags)`
`long`	`getId()`
`String`	`getTitle()`
`String`	`getDescription()`
`Long`	`getBrandId()`
`String`	`getBrandName()`
`String`	`getValidationToken()`
`OfferState`	`getState()`
`RewardType`	`getRewardType()`
`MenigaDecimal`	`getReward()`
`MenigaDecimal`	`getTotalRedeemedAmount()`
`MenigaDecimal`	`getMinimumPurchaseAmount()`
`MenigaDecimal`	`getMaximumRedemptionPerOffer()`
`MenigaDecimal`	`getMaximumRedemptionPerPurchase()`
`MenigaDecimal`	`getMinimumAccumulatedAmount()`
`Integer`	`getMaximumPurchase()`
`MenigaDecimal`	`getLastReimbursementAmount()`
`DateTime`	`getLastReimbursementDate()`
`MenigaDecimal`	`getScheduledReimbursementAmount()`
`DateTime`	`getScheduledReimbursementDate()`
`int`	`getDaysLeft()`
`DateTime`	`getValidFrom()`
`DateTime`	`getValidTo()`
`DateTime`	`getActivatedDate()`
`DateTime`	`getDeclineDate()`
`String`	`getMerchantName()`
`RelevanceHookDisplay`	`getRelevanceHook()`
`MenigaDecimal`	`getTotalSpendingAtSimilarBrands()`
`MenigaDecimal`	`getTotalSpendingOnOffer()`
`MenigaDecimal`	`getOfferSimilarBrandsSpendingRatio()`
`List<MenigaOfferMerchantLocation>`	`getMerchantLocations()`
`String`	`getWebUri()`
`String`	`getWebUriLabel()`

Methods inherited from class android.os.Parcelable
describeContents, writeToParcel
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setOperator
```
 static void setOperator(MenigaOfferOperations operator)
```
    Sets the api operator for doing api calls
    
    Parameters:
    
    operator - An object that implements the MenigaOfferOperations interface for carrying out api operations on this class.
  - isMerchantDeclined
```
 boolean isMerchantDeclined()
```
  - isActivateOfferOnFirstPurchase
```
 boolean isActivateOfferOnFirstPurchase()
```
  - equals
```
 boolean equals(Object o)
```
  - hashCode
```
 int hashCode()
```
  - fetch
```
 static Result<MenigaOfferPage> fetch(int skip, int take, List<OfferFilterState> states, List<Long> offerIds, boolean expiredWithRedemptionOnly)
```
    Returns offers and relevant meta data.
    
    Parameters:
    
    skip - how many offers should be skipped
    
    take - how many offers should be taken per page
    
    states - state of offers that should be fetched.
    
    offerIds - specific offers ids to fetch
    
    expiredWithRedemptionOnly - Fetch only excpired offers that have redemptions
  - fetch
```
 static Result<MenigaOffer> fetch(long id)
```
    Returns offer with specific id
    
    Parameters:
    
    id - specific offer id
  - fetch
```
 static Result<MenigaOffer> fetch(String validationToken)
```
    Returns offer with specific validation token
    
    Parameters:
    
    validationToken - specific offer validation token
  - fetch
```
@Deprecated() static Result<MenigaOfferPage> fetch(List<OfferFilterState> states)
```
    Returns offers and relevant meta data.
    
    Parameters:
    
    states - state of offers that should be fetched.
  - fetchId
```
@Deprecated() static Result<MenigaOfferPage> fetchId(List<Long> offerIds)
```
    Returns offers and relevant meta data by specific ids
    
    Parameters:
    
    offerIds - specific offer ids to fetch.
  - fetch
```
 static Result<MenigaOfferPage> fetch(int skip, int take)
```
    Returns offers and relevant meta data
    
    Parameters:
    
    skip - number of records to skip
    
    take - Number of records to return
  - activate
```
 Result<Void> activate()
```
    Activate offer by offer id
  - activateByToken
```
 Result<Void> activateByToken()
```
    Activate offer by offer by validation token
  - activateByToken
```
 static Result<Void> activateByToken(String validationToken)
```
  - seen
```
 static Result<Void> seen(long offerId)
```
    Mark offer as seen
    
    Parameters:
    
    offerId - id of offer
  - decline
```
 Result<Void> decline()
```
    Decline offer
  - markAsSeen
```
 Result<Void> markAsSeen()
```
    Mark offer as seen
  - fetchSimilarBrandSpendingDetails
```
 Result<MenigaSimilarBrandSpendingDetails> fetchSimilarBrandSpendingDetails()
```
    Fetch similar brand spending details
  - fetchSimilarBrandSpendingDetailsById
```
 static Result<MenigaSimilarBrandSpendingDetails> fetchSimilarBrandSpendingDetailsById(int id)
```
    Fetch similar brand spending details by offer id
    
    Parameters:
    
    id - offer id of the offer for which the details are to be retrieved
  - fetchRedemptions
```
 Result<MenigaRedemptions> fetchRedemptions()
```
    Fetch redemption transactions
  - fetchRedemptionsById
```
 static Result<MenigaRedemptions> fetchRedemptionsById(int id)
```
    Fetch redemption transactions by offer id
    
    Parameters:
    
    id - offer id of the offer for which the redemption transactions are to be retrieved
  - fetchNearbyMerchantLocations
```
 Result<MenigaOfferMerchantLocationPage> fetchNearbyMerchantLocations(Double latitude, Double longitude, Double radiumKm, Integer limitLocations)
```
    Fetch nearby merchant locations
    
    Parameters:
    
    latitude - central latitude for location filtering
    
    longitude - central longitude for location filtering
    
    radiumKm - radius in km for location filtering
    
    limitLocations - the maximum number of locations to be returned (per offer)
  - fetchNearbyMerchantLocationsById
```
 static Result<MenigaOfferMerchantLocationPage> fetchNearbyMerchantLocationsById(int id, Double latitude, Double longitude, Double radiumKm, Integer limitLocations)
```
    Fetch nearby merchant locations by offer id
    
    Parameters:
    
    id - offer id of the offer for which the locations are to be retrieved
    
    latitude - central latitude for location filtering
    
    longitude - central longitude for location filtering
    
    radiumKm - radius in km for location filtering
    
    limitLocations - the maximum number of locations to be returned (per offer)
  - describeContents
```
 int describeContents()
```
  - writeToParcel
```
 void writeToParcel(Parcel dest, int flags)
```
  - getId
```
 long getId()
```
  - getTitle
```
 String getTitle()
```
  - getDescription
```
 String getDescription()
```
  - getBrandId
```
 Long getBrandId()
```
  - getBrandName
```
 String getBrandName()
```
  - getValidationToken
```
 String getValidationToken()
```
  - getState
```
 OfferState getState()
```
  - getRewardType
```
 RewardType getRewardType()
```
  - getReward
```
 MenigaDecimal getReward()
```
  - getTotalRedeemedAmount
```
 MenigaDecimal getTotalRedeemedAmount()
```
  - getMinimumPurchaseAmount
```
 MenigaDecimal getMinimumPurchaseAmount()
```
  - getMaximumRedemptionPerOffer
```
 MenigaDecimal getMaximumRedemptionPerOffer()
```
  - getMaximumRedemptionPerPurchase
```
 MenigaDecimal getMaximumRedemptionPerPurchase()
```
  - getMinimumAccumulatedAmount
```
 MenigaDecimal getMinimumAccumulatedAmount()
```
  - getMaximumPurchase
```
 Integer getMaximumPurchase()
```
  - getLastReimbursementAmount
```
 MenigaDecimal getLastReimbursementAmount()
```
  - getLastReimbursementDate
```
 DateTime getLastReimbursementDate()
```
  - getScheduledReimbursementAmount
```
 MenigaDecimal getScheduledReimbursementAmount()
```
  - getScheduledReimbursementDate
```
 DateTime getScheduledReimbursementDate()
```
  - getDaysLeft
```
 int getDaysLeft()
```
  - getValidFrom
```
 DateTime getValidFrom()
```
  - getValidTo
```
 DateTime getValidTo()
```
  - getActivatedDate
```
 DateTime getActivatedDate()
```
  - getDeclineDate
```
 DateTime getDeclineDate()
```
  - getMerchantName
```
 String getMerchantName()
```
  - getRelevanceHook
```
 RelevanceHookDisplay getRelevanceHook()
```
  - getTotalSpendingAtSimilarBrands
```
 MenigaDecimal getTotalSpendingAtSimilarBrands()
```
  - getTotalSpendingOnOffer
```
 MenigaDecimal getTotalSpendingOnOffer()
```
  - getOfferSimilarBrandsSpendingRatio
```
 MenigaDecimal getOfferSimilarBrandsSpendingRatio()
```
  - getMerchantLocations
```
 List<MenigaOfferMerchantLocation> getMerchantLocations()
```
  - getWebUri
```
 String getWebUri()
```
  - getWebUriLabel
```
 String getWebUriLabel()
```

Class MenigaOffer

Field Summary

Method Summary

Methods inherited from class android.os.Parcelable

Methods inherited from class java.lang.Object

Method Detail

setOperator

isMerchantDeclined

isActivateOfferOnFirstPurchase

equals

hashCode

fetch

fetch

fetch

fetch

fetchId

fetch

activate

activateByToken

activateByToken

seen

decline

markAsSeen

fetchSimilarBrandSpendingDetails

fetchSimilarBrandSpendingDetailsById

fetchRedemptions

fetchRedemptionsById

fetchNearbyMerchantLocations

fetchNearbyMerchantLocationsById

describeContents

writeToParcel

getId

getTitle

getDescription

getBrandId

getBrandName

getValidationToken

getState

getRewardType

getReward

getTotalRedeemedAmount

getMinimumPurchaseAmount

getMaximumRedemptionPerOffer

getMaximumRedemptionPerPurchase

getMinimumAccumulatedAmount

getMaximumPurchase

getLastReimbursementAmount

getLastReimbursementDate

getScheduledReimbursementAmount

getScheduledReimbursementDate

getDaysLeft

getValidFrom

getValidTo

getActivatedDate

getDeclineDate

getMerchantName

getRelevanceHook

getTotalSpendingAtSimilarBrands

getTotalSpendingOnOffer

getOfferSimilarBrandsSpendingRatio

getMerchantLocations

getWebUri

getWebUriLabel