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


public class MenigaChallenge
 implements Serializable, Cloneable, Parcelable

Field Summary

Fields
Modifier and Type	Field	Description
`protected UUID`	`id`
`protected DateTime`	`acceptedDate`
`protected Long`	`topicId`
`protected String`	`title`
`protected String`	`description`
`protected ChallengeType`	`type`
`protected DateTime`	`publishDate`
`protected DateTime`	`startDate`
`protected DateTime`	`endDate`
`protected DateTime`	`parentEndDate`
`protected DateTime`	`parentStartDate`
`protected List<Long>`	`categoryIds`
`protected Integer`	`targetPercentage`
`protected MenigaDecimal`	`targetAmount`
`protected MenigaDecimal`	`spentAmount`
`protected String`	`iconUrl`
`protected ChallengeInterval`	`recurringInterval`
`protected CustomChallengeColor`	`customChallengeColor`
`protected Long`	`parentTopicId`
`public final static Parcelable.Creator<MenigaChallenge>`	`CREATOR`

Method Summary

Modifier and Type	Method	Description
`int`	`describeContents()`
`void`	`writeToParcel(Parcel dest, int flags)`
`boolean`	`equals(Object o)`
`int`	`hashCode()`
`boolean`	`isAccepted()`
`DateTime`	`getMostValidStartDate()`
`DateTime`	`getMostValidEndDate()`
`static void`	`setOperator(MenigaChallengesOperations operator)`	Sets the api operator for doing api calls
`MenigaChallenge`	`clone()`
`String`	`toString()`
`void`	`merge(MenigaChallenge other)`	Merges another MenigaChallenge object into this.
`static Result<List<MenigaChallenge>>`	`fetch()`	Gets all challenges - expired, suggested, accepted and disabled.
`static Result<MenigaChallenge>`	`fetch(UUID id)`	Gets a challenge by its unique id.
`Result<MenigaChallenge>`	`refresh()`	Refreshes this instance with fresh new data from the server (if there have been any changes that is).
`static Result<List<MenigaChallenge>>`	`fetch(boolean includeExpired, boolean excludeSuggested, boolean excludeAccepted)`	Gets challenges based on provided parameters.
`static Result<List<MenigaChallenge>>`	`fetch(FetchChallengeFilter filter)`	Gets all challenges matching the filter provided.
`Result<Void>`	`update()`	Updates the instance on the server.
`static Result<Void>`	`delete(UUID id)`	Delete the instance by id on the server.
`Result<Void>`	`delete()`	Delete the instance on the server.
`Result<MenigaChallenge>`	`accept(MenigaDecimal targetAmount)`	Marks the challenges object as accepted
`Result<Void>`	`disable()`	Pauses previously accepted challenge.
`Result<Void>`	`enable()`	Resumes previously disabled challenge.
`static Result<MenigaChallenge>`	`create(String title, String description, DateTime startDate, DateTime endDate, List<Long> categoryIds, MenigaDecimal targetAmount, CustomChallengeColor color)`	Creates a new custom challenge object with a default value for iconId
`static Result<MenigaChallenge>`	`create(String title, String description, DateTime startDate, DateTime endDate, List<Long> categoryIds, MenigaDecimal targetAmount, CustomChallengeColor color, ChallengeInterval interval)`	Creates a new custom challenge object with a default value for iconId
`static Result<MenigaChallenge>`	`create(String title, String description, DateTime startDate, DateTime endDate, List<Long> categoryIds, MenigaDecimal targetAmount, Long iconId, CustomChallengeColor color)`	Creates a new custom challenge object
`static Result<MenigaChallenge>`	`create(String title, String description, DateTime startDate, DateTime endDate, List<Long> categoryIds, MenigaDecimal targetAmount, Long iconId, CustomChallengeColor color, ChallengeInterval interval)`	Creates a new custom challenge object with a recurring interval
`static Result<MenigaChallenge>`	`create(NewChallenge challenge)`	Creates a new custom challenge object with a recurring interval
`Result<List<MenigaChallenge>>`	`history(int page, int numPerPage)`	Fetches previous completed instances of this challenge, if it was a recurring challenge
`UUID`	`getId()`
`DateTime`	`getAcceptedDate()`
`Long`	`getTopicId()`
`String`	`getTitle()`
`String`	`getDescription()`
`ChallengeType`	`getType()`
`DateTime`	`getPublishDate()`
`DateTime`	`getStartDate()`
`DateTime`	`getEndDate()`
`DateTime`	`getParentEndDate()`
`DateTime`	`getParentStartDate()`
`List<Long>`	`getCategoryIds()`
`Integer`	`getTargetPercentage()`
`MenigaDecimal`	`getTargetAmount()`
`MenigaDecimal`	`getSpentAmount()`
`String`	`getIconUrl()`
`ChallengeInterval`	`getRecurringInterval()`
`CustomChallengeColor`	`getCustomChallengeColor()`
`Long`	`getParentTopicId()`
`void`	`setTitle(String titleIn)`
`void`	`setDescription(String desc)`
`void`	`setType(ChallengeType type)`
`void`	`setStartDate(DateTime starts)`
`void`	`setEndDate(DateTime ends)`
`void`	`setCategoryIds(List<Long> ids)`
`void`	`setTargetAmount(MenigaDecimal amt)`
`void`	`setIconUrl(String url)`
`void`	`setCustomChallengeColor(CustomChallengeColor color)`

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
  - describeContents
```
 int describeContents()
```
  - writeToParcel
```
 void writeToParcel(Parcel dest, int flags)
```
  - equals
```
 boolean equals(Object o)
```
  - hashCode
```
 int hashCode()
```
  - isAccepted
```
 boolean isAccepted()
```
  - getMostValidStartDate
```
 DateTime getMostValidStartDate()
```
  - getMostValidEndDate
```
 DateTime getMostValidEndDate()
```
  - setOperator
```
 static void setOperator(MenigaChallengesOperations operator)
```
    Sets the api operator for doing api calls
    
    Parameters:
    
    operator - An object that implements the MenigaMerchantOperations interface for carrying out api operations on this class.
  - clone
```
 MenigaChallenge clone()
```
  - toString
```
 String toString()
```
  - merge
```
 void merge(MenigaChallenge other)
```
    Merges another MenigaChallenge object into this. Replaces null fields on this object withfields from other if the field in other is not null
    
    Parameters:
    
    other - The other MenigaChallenge object to merge with this one
  - fetch
```
 static Result<List<MenigaChallenge>> fetch()
```
    Gets all challenges - expired, suggested, accepted and disabled.
  - fetch
```
 static Result<MenigaChallenge> fetch(UUID id)
```
    Gets a challenge by its unique id.
    
    Parameters:
    
    id - The id of the challenge to getChallenge
  - refresh
```
 Result<MenigaChallenge> refresh()
```
    Refreshes this instance with fresh new data from the server (if there have been any changes that is).
  - fetch
```
@Deprecated() static Result<List<MenigaChallenge>> fetch(boolean includeExpired, boolean excludeSuggested, boolean excludeAccepted)
```
    Gets challenges based on provided parameters.
    
    Parameters:
    
    includeExpired - if true includes expired challenges
    
    excludeSuggested - if true excludes suggested challenges
    
    excludeAccepted - if true excludes accepted challenges
  - fetch
```
 static Result<List<MenigaChallenge>> fetch(FetchChallengeFilter filter)
```
    Gets all challenges matching the filter provided.
    
    Parameters:
    
    filter - query filter
  - update
```
 Result<Void> update()
```
    Updates the instance on the server. All fields that have a setter can be updated
  - delete
```
 static Result<Void> delete(UUID id)
```
    Delete the instance by id on the server.
  - delete
```
 Result<Void> delete()
```
    Delete the instance on the server.
  - accept
```
 Result<MenigaChallenge> accept(MenigaDecimal targetAmount)
```
    Marks the challenges object as accepted
  - disable
```
 Result<Void> disable()
```
    Pauses previously accepted challenge.
  - enable
```
 Result<Void> enable()
```
    Resumes previously disabled challenge.
  - create
```
@Deprecated() static Result<MenigaChallenge> create(String title, String description, DateTime startDate, DateTime endDate, List<Long> categoryIds, MenigaDecimal targetAmount, CustomChallengeColor color)
```
    Creates a new custom challenge object with a default value for iconId
    
    Parameters:
    
    title - Title of the challenge
    
    description - Description of the challange
    
    startDate - Time period start for when the challenge starts
    
    endDate - Time period end for when the challenge starts
    
    categoryIds - Category ids that this challenge applies to
    
    targetAmount - The budget target amount for the challenge
    
    color - Color of the challenge being created
  - create
```
@Deprecated() static Result<MenigaChallenge> create(String title, String description, DateTime startDate, DateTime endDate, List<Long> categoryIds, MenigaDecimal targetAmount, CustomChallengeColor color, ChallengeInterval interval)
```
    Creates a new custom challenge object with a default value for iconId
    
    Parameters:
    
    title - Title of the challenge
    
    description - Description of the challange
    
    startDate - Time period start for when the challenge starts
    
    endDate - Time period end for when the challenge starts
    
    categoryIds - Category ids that this challenge applies to
    
    targetAmount - The budget target amount for the challenge
    
    color - Color of the challenge being created
  - create
```
@Deprecated() static Result<MenigaChallenge> create(String title, String description, DateTime startDate, DateTime endDate, List<Long> categoryIds, MenigaDecimal targetAmount, Long iconId, CustomChallengeColor color)
```
    Creates a new custom challenge object
    
    Parameters:
    
    title - Title of the challenge
    
    description - Description of the challange
    
    startDate - Time period start for when the challenge starts
    
    endDate - Time period end for when the challenge starts
    
    categoryIds - Category ids that this challenge applies to
    
    targetAmount - The budget target amount for the challenge
    
    iconId - Id of the icon associated with the challenge
    
    color - Color of the challenge being created
  - create
```
@Deprecated() static Result<MenigaChallenge> create(String title, String description, DateTime startDate, DateTime endDate, List<Long> categoryIds, MenigaDecimal targetAmount, Long iconId, CustomChallengeColor color, ChallengeInterval interval)
```
    Creates a new custom challenge object with a recurring interval
    
    Parameters:
    
    title - Title of the challenge
    
    description - Description of the challange
    
    startDate - Time period start for when the challenge starts
    
    endDate - Time period end for when the challenge starts
    
    categoryIds - Category ids that this challenge applies to
    
    targetAmount - The budget target amount for the challenge
    
    iconId - Id of the icon associated with the challenge
    
    color - Color of the challenge being created
    
    interval - The interval between repeats, e.g.
  - create
```
 static Result<MenigaChallenge> create(NewChallenge challenge)
```
    Creates a new custom challenge object with a recurring interval
    
    Parameters:
    
    challenge - new challenge data
  - history
```
 Result<List<MenigaChallenge>> history(int page, int numPerPage)
```
    Fetches previous completed instances of this challenge, if it was a recurring challenge
    
    Parameters:
    
    page - The page to fetch if the number of results are more than numPerPage
    
    numPerPage - The number of challenges per page
  - getId
```
 UUID getId()
```
  - getAcceptedDate
```
 DateTime getAcceptedDate()
```
  - getTopicId
```
 Long getTopicId()
```
  - getTitle
```
 String getTitle()
```
  - getDescription
```
 String getDescription()
```
  - getType
```
 ChallengeType getType()
```
  - getPublishDate
```
 DateTime getPublishDate()
```
  - getStartDate
```
 DateTime getStartDate()
```
  - getEndDate
```
 DateTime getEndDate()
```
  - getParentEndDate
```
 DateTime getParentEndDate()
```
  - getParentStartDate
```
 DateTime getParentStartDate()
```
  - getCategoryIds
```
 List<Long> getCategoryIds()
```
  - getTargetPercentage
```
 Integer getTargetPercentage()
```
  - getTargetAmount
```
 MenigaDecimal getTargetAmount()
```
  - getSpentAmount
```
 MenigaDecimal getSpentAmount()
```
  - getIconUrl
```
 String getIconUrl()
```
  - getRecurringInterval
```
 ChallengeInterval getRecurringInterval()
```
  - getCustomChallengeColor
```
 CustomChallengeColor getCustomChallengeColor()
```
  - getParentTopicId
```
 Long getParentTopicId()
```
  - setTitle
```
 void setTitle(String titleIn)
```
  - setDescription
```
 void setDescription(String desc)
```
  - setType
```
 void setType(ChallengeType type)
```
  - setStartDate
```
 void setStartDate(DateTime starts)
```
  - setEndDate
```
 void setEndDate(DateTime ends)
```
  - setCategoryIds
```
 void setCategoryIds(List<Long> ids)
```
  - setTargetAmount
```
 void setTargetAmount(MenigaDecimal amt)
```
  - setIconUrl
```
 void setIconUrl(String url)
```
  - setCustomChallengeColor
```
 void setCustomChallengeColor(CustomChallengeColor color)
```

Class MenigaChallenge

Field Summary

Method Summary

Methods inherited from class android.os.Parcelable

Methods inherited from class java.lang.Object

Method Detail

describeContents

writeToParcel

equals

hashCode

isAccepted

getMostValidStartDate

getMostValidEndDate

setOperator

clone

toString

merge

fetch

fetch

refresh

fetch

fetch

update

delete

delete

accept

disable

enable

create

create

create

create

create

history

getId

getAcceptedDate

getTopicId

getTitle

getDescription

getType

getPublishDate

getStartDate

getEndDate

getParentEndDate

getParentStartDate

getCategoryIds

getTargetPercentage

getTargetAmount

getSpentAmount

getIconUrl

getRecurringInterval

getCustomChallengeColor

getParentTopicId

setTitle

setDescription

setType

setStartDate

setEndDate

setCategoryIds

setTargetAmount

setIconUrl

setCustomChallengeColor