com.captainup.android.core.model

Class BadgeProgressImpl

java.lang.Object

com.captainup.android.core.model.BadgeProgressImpl

All Implemented Interfaces:

BadgeProgress, CaptainUpObject

public final class BadgeProgressImpl
extends java.lang.Object
implements BadgeProgress

Constructor Summary

Constructors

Constructor and Description
BadgeProgressImpl(double progress, int timesCompleted, int completedConditionsCount, java.util.Map<java.lang.String,ConditionProgress> conditionsProgress, java.util.Date completedDate, java.util.Map<java.lang.String,RewardProgress> rewardProgress)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
int	getCompletedConditionsCount() The number of conditions completed
java.util.Date	getCompletedDate() The latest date the badge was completed on.
java.util.Map<java.lang.String,ConditionProgress>	getConditionsProgress() The badge's conditions progress
double	getProgress() The user’s badge progress, as a number between 0 and 1.
java.util.Map<java.lang.String,RewardProgress>	getRewardProgress() Map of the badge rewards (key: reward ID, value: RewardProgress obejct) When you want to know if a reward has already been claimed (therefor there's no need to show a 'claim!' dialog to the user, for example) you can get the rewardsProgress Map from the badgeProgress object and use the .isClaimed() function.
int	getTimesCompleted() The number of times the user has completed this badge.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BadgeProgressImpl

public BadgeProgressImpl(double progress,
                         int timesCompleted,
                         int completedConditionsCount,
                         java.util.Map<java.lang.String,ConditionProgress> conditionsProgress,
                         java.util.Date completedDate,
                         java.util.Map<java.lang.String,RewardProgress> rewardProgress)

Method Detail

getRewardProgress

public java.util.Map<java.lang.String,RewardProgress> getRewardProgress()

Description copied from interface: BadgeProgress

Map of the badge rewards (key: reward ID, value: RewardProgress obejct) When you want to know if a reward has already been claimed (therefor there's no need to show a 'claim!' dialog to the user, for example) you can get the rewardsProgress Map from the badgeProgress object and use the .isClaimed() function. A usage example to check if a badge reward is claimed: RewardProgress rewardProgress = CaptainUp.getLoggedInUser().getBadgeProgress().get(badge.getID()).getRewardProgress().get(badge.getReward().getID()); rewardProgress.isClaimed()

Specified by:

getRewardProgress in interface BadgeProgress

Returns:

the badge rewards progress map

getProgress

public double getProgress()

Description copied from interface: BadgeProgress

The user’s badge progress, as a number between 0 and 1. Completed badges will have `1` as their progress, badges with no progress will have `0` as their progress. For example, if the user visited one time, out of a total of four required visits, then the progress will be set to 0.25.

Specified by:

getProgress in interface BadgeProgress

Returns:

the badge progress as a number between 0.0 (inclusive) and 1.0 (inclusive)

getCompletedConditionsCount

public int getCompletedConditionsCount()

Description copied from interface: BadgeProgress

The number of conditions completed

Specified by:

getCompletedConditionsCount in interface BadgeProgress

Returns:

the number of conditions completed

getConditionsProgress

public java.util.Map<java.lang.String,ConditionProgress> getConditionsProgress()

Description copied from interface: BadgeProgress

The badge's conditions progress

Specified by:

getConditionsProgress in interface BadgeProgress

Returns:

a Map between a condition ID and its progress.

getTimesCompleted

public int getTimesCompleted()

Description copied from interface: BadgeProgress

The number of times the user has completed this badge.

• If 0, then the user did not completed the badge
• If 1, then the user completed the badge exactly once
• If 1, this is repeatable badge, and the user had completed it multiple times

Specified by:

getTimesCompleted in interface BadgeProgress

Returns:

a non-negative value representing the number of times the badge was completed.

getCompletedDate

public java.util.Date getCompletedDate()

Description copied from interface: BadgeProgress

The latest date the badge was completed on.

Specified by:

getCompletedDate in interface BadgeProgress

Returns:

the latest date the badge was completed on. May be equal to null, depending on the source of the information. Specifically, information that is derived from a Create Action Response, might not contain the completion date for a completed badge. To check if a badge was completed or not see BadgeProgress.getTimesCompleted()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object