com.microstrategy.usher

Class BadgeModel

java.lang.Object

com.microstrategy.usher.BadgeModel

public abstract class BadgeModel
extends java.lang.Object

The BadgeModel abstract class wraps the core attributes pertaining to the badge found in a BadgeEntity with other more dynamic attributes, such as the list of pending badge conditions required to be satisfied before the badge is able to be used.

Method Summary

Modifier and Type	Method and Description
abstract boolean	activated() Returns a boolean that represents whether or not the badge is activated.
abstract BadgeEntity	badgeEntity() Returns a BadgeEntity object that wraps the core attributes pertaining to the badge.
abstract java.util.List<BadgeCondition>	pendingBadgeConditionList() Returns the List of BadgeCondition objects that includes various requirements and restrictions that must be fulfilled before the badge is able to be used.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

badgeEntity

public abstract BadgeEntity badgeEntity()

Returns a BadgeEntity object that wraps the core attributes pertaining to the badge.

Returns:

a BadgeEntity object.

pendingBadgeConditionList

public abstract java.util.List<BadgeCondition> pendingBadgeConditionList()

Returns the List of BadgeCondition objects that includes various requirements and restrictions that must be fulfilled before the badge is able to be used.

Returns:

the List of BadgeCondition objects of the badge.

activated

public abstract boolean activated()

Returns a boolean that represents whether or not the badge is activated. See BadgeEntity.activated(long).

Returns:

true if the badge is activated; false otherwise.