com.microstrategy.usher

Class BadgeEntity

java.lang.Object

com.microstrategy.usher.BadgeEntity

public abstract class BadgeEntity
extends java.lang.Object

The BadgeEntity abstract class wraps the core attributes pertaining to the badge. These attributes are derived from the bean and are further broken down into the more dynamic BadgeModel.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BadgeEntity.Status The various enumerations for Status.

Method Summary

Modifier and Type	Method and Description
boolean	activated(long nowInSeconds) Returns a boolean that represents whether or not the badge has been activated.
abstract java.util.List<com.microstrategy.usher.BadgeAdditionInfoItem>	badgeAdditionInfoItemList() Returns the List of BadgeAdditionInfoItem objects that wrap core attribute items related to the badge for use as a key/value pair.
abstract int	badgeId() Returns an int of the identification number of the badge.
abstract BadgeStatusEntity	badgeStatusEntity() Returns a BadgeStatusEntity object that includes various attributes about the current status of the badge related to logging in and being ready to use, including mobile phone number enrollment and verification and terms of use/privacy policy acknowledgement.
abstract BadgeUIEntity	badgeUIEntity() Returns a BadgeUIEntity object that includes various attributes about the presentation of a badge, including organization name, employee name, and employee title, among others.
abstract OrgConfigEntity	orgConfigEntity() Returns a OrgConfigEntity object that includes various attributes about the badge condition stored in the cache.
abstract OrgUIEntity	orgUIEntity() Returns a OrgUIEntity object that includes various attributes about the organization and its configuration for Usher, including organization ID and organization name, among others.
abstract BadgeEntity.Status	status() Returns a BadgeEntity.Status enumeration that represents the current status of the badge in relation to logging in and being ready to use.
abstract java.util.List<RegionEntity>	telemetryConditionItemList() Returns the List of RegionEntity objects that includes various attributes about the region restrictions (i.e.
java.lang.String	toString() Returns a String of the badge ID and the name of the badge.

Methods inherited from class java.lang.Object

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

Method Detail

badgeId

public abstract int badgeId()

Returns an int of the identification number of the badge.

Returns:

the identification number of the badge.

badgeStatusEntity

public abstract BadgeStatusEntity badgeStatusEntity()

Returns a BadgeStatusEntity object that includes various attributes about the current status of the badge related to logging in and being ready to use, including mobile phone number enrollment and verification and terms of use/privacy policy acknowledgement.

Returns:

the BadgeStatusEntity of the badge.

badgeUIEntity

public abstract BadgeUIEntity badgeUIEntity()

Returns a BadgeUIEntity object that includes various attributes about the presentation of a badge, including organization name, employee name, and employee title, among others.

Returns:

the BadgeUIEntity of the badge.

orgConfigEntity

public abstract OrgConfigEntity orgConfigEntity()

Returns a OrgConfigEntity object that includes various attributes about the badge condition stored in the cache. This includes various restrictions needed to be fulfilled before the badge is able to be used.

Returns:

the OrgConfigEntity of the badge.

orgUIEntity

public abstract OrgUIEntity orgUIEntity()

Returns a OrgUIEntity object that includes various attributes about the organization and its configuration for Usher, including organization ID and organization name, among others.

Returns:

the OrgUIEntity of the badge.

telemetryConditionItemList

public abstract java.util.List<RegionEntity> telemetryConditionItemList()

Returns the List of RegionEntity objects that includes various attributes about the region restrictions (i.e. geofences) associated with the badge. This includes various properties such as latitude, longitude, and radius of a geofence.

Returns:

the List of RegionEntity objects of the badge.

status

public abstract BadgeEntity.Status status()

Returns a BadgeEntity.Status enumeration that represents the current status of the badge in relation to logging in and being ready to use.

Returns:

the BadgeEntity.Status of the badge. BadgeEntity.Status enumerations include:

• ACTIVATED
• PENDING_LOGIN
• PENDING_PHONE_NUMBER_ENROLLMENT
• PENDING_PHONE_NUMBER_VERIFICATION
• PENDING_PROFILE_PHOTO
• PENDING_TYPE_PRIVACY_POLICY
• PENDING_TYPE_TERM_OF_USE
• REVOKED

activated

public boolean activated(long nowInSeconds)

Returns a boolean that represents whether or not the badge has been activated. Activation is defined as either having the BadgeEntity.Status.ACTIVATED option achieved by enrolling and verifying a mobile phone number for a device or being within the grace period of mobile phone number enrollment defined on Network Manager.

Parameters:

nowInSeconds - the current time in seconds, used to calculate whether or not the device is within the grace period of mobile phone number enrollment.

Returns:

true if the status is equal to BadgeEntity.Status.ACTIVATED or if the device is within the grace period of mobile phone number enrollment defined on Network Manager; false otherwise.

badgeAdditionInfoItemList

@Nullable
public abstract java.util.List<com.microstrategy.usher.BadgeAdditionInfoItem> badgeAdditionInfoItemList()

Returns the List of BadgeAdditionInfoItem objects that wrap core attribute items related to the badge for use as a key/value pair.

Returns:

the List of BadgeAdditionInfoItem objects

toString

public java.lang.String toString()

Returns a String of the badge ID and the name of the badge.

Overrides:

toString in class java.lang.Object

Returns:

the badge ID and the name of the badge.