OrgUIEntity

java.lang.Object
- com.microstrategy.usher.OrgUIEntity

```
public abstract class OrgUIEntity
extends java.lang.Object
```
The OrgUIEntity abstract class wraps various attributes about the organization and its configuration for MicroStrategy Badge, including organization ID and organization name, among others.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class OrgUIEntity.LocationTrackingConfig
The enumerations for OrgUIEntity.LocationTrackingConfig.

Nested Classes
Modifier and Type	Class and Description
`static class`	`OrgUIEntity.LocationTrackingConfig` The enumerations for `OrgUIEntity.LocationTrackingConfig`.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`BASIC_COLOR_BLUE` Basic blue background color.
`static java.lang.String`	`BASIC_COLOR_GRAY` Basic gray background color.
`static java.lang.String`	`BASIC_COLOR_GREEN` Basic green background color.
`static java.lang.String`	`BASIC_COLOR_PURPLE` Basic purple background color.
`static java.lang.String`	`BASIC_COLOR_RED` Basic red background color.
`static java.lang.String`	`DEFAULT_BADGE_BACKGROUND_COLOR` Default badge background color.
`static java.lang.String`	`DEFAULT_BADGE_TEXT_COLOR` Default badge text color.
`static int`	`DEFAULT_TOTP_CODE_DURATION` Default duration in seconds a time-based one-time password (TOTP) will last before expiring.
`static int`	`DEFAULT_USHER_CODE_OFFLINE_DURATION` Default duration in seconds a MicroStrategy Badge code will last before expiring when the device is not connected to a network.
`static int`	`DEFAULT_USHER_CODE_ONLINE_DURATION` Default duration in seconds a MicroStrategy Badge code will last before expiring when the device is connected to a network.
`static int`	`DEFAULT_USHER_CODE_VERSION` Default MicroStrategy Badge code version.
`static int`	`LEGACY_CONFIGURATION_SHOW_USHER_CODE` Legacy configuration for showing MicroStrategy Badge code.
`static int`	`NEW_USHER_CODE_VERSION` New MicroStrategy Badge code version.
`static int`	`ONLINE_CONFIGURATION_SHOW_NEITHER_USHER_CODE_OR_TOTP_CODE` Server configuration for not showing either MicroStrategy Badge code of time-based one-time password (TOTP).
`static int`	`ONLINE_CONFIGURATION_SHOW_TOTP_CODE` Server configuration for showing the time-based one-time password (TOTP).
`static int`	`ONLINE_CONFIGURATION_SHOW_USHER_CODE` Server configuration for showing the MicroStrategy Badge code.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract java.lang.String`	`backgroundColor()` Returns a String of the background color of badges.
`abstract java.lang.String`	`backgroundImageUrl()` Returns a String of the URL of the background image.
`abstract java.lang.String`	`backgroundImageUrlCheckSum()` Returns a String of the checksum of the URL of the background image.
`abstract java.lang.String`	`badgeName()` Returns a String of the name of the badge.
`abstract int`	`codeDisplayType()` Returns an int of the type of code a badge should display.
`abstract boolean`	`fingerprintEnabled()` Returns a boolean that represents whether or not fingerprint authentication is required.
`abstract OrgUIEntity.LocationTrackingConfig`	`locationTrackingConfig()` Returns a `OrgUIEntity.LocationTrackingConfig` that represents the requirement for location reporting.
`abstract java.lang.String`	`orgIconCheckSum()` Returns a String of the checksum of the organization icon.
`abstract java.lang.String`	`orgIconUrl()` Returns a String of the URL of the organization icon.
`abstract int`	`orgId()` Returns an int of the identification number of the organization.
`abstract java.lang.String`	`orgName()` Returns a String of the name of the organization.
`abstract boolean`	`passcodeEnabled()` Returns a boolean that represents whether or not a passcode is required.
`abstract java.lang.String`	`privacyPolicyLink()` Returns a String of the address of the privacy policy.
`abstract boolean`	`reportScannedData()` Returns a boolean that represents whether or not scanned data should be reported to the server.
`abstract boolean`	`showGradient()` Returns a boolean that represents whether or not a gradient should be shown on the background color of the badge.
`abstract boolean`	`showPrivacyLink()` Returns a boolean that represents whether or not the link to the privacy policy should be shown.
`abstract boolean`	`showTermOfUseLink()` Returns a boolean that represents whether or not the link to the terms of use should be shown.
`abstract java.lang.String`	`termOfUseLink()` Returns a String of the address of the terms of use.
`abstract java.lang.String`	`textColor()` Returns a String of the text color of badges.
`java.lang.String`	`toString()` Returns a String of the organization ID and the name of the organization.
`abstract int`	`totpCodeDuration()` Returns an int of the duration in seconds a time-based one-time password (TOTP) will last before expiring.
`abstract int`	`usherCodeOfflineDuration()` Returns an int of the duration in seconds a MicroStrategy Badge code will last before expiring when the device is not connected to a network.
`abstract int`	`usherCodeOnlineDuration()` Returns an int of the duration in seconds a MicroStrategy Badge code will last before expiring when the device is connected to a network.
`abstract int`	`usherCodeVersion()` Returns an int of the MicroStrategy Badge code version for badges.
`abstract OrgUIEntity`	`withOrgName(java.lang.String orgName)` Constructor for an `OrgUIEntity` object with the orgName set.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - LEGACY_CONFIGURATION_SHOW_USHER_CODE
```
public static final int LEGACY_CONFIGURATION_SHOW_USHER_CODE
```
    Legacy configuration for showing MicroStrategy Badge code. Value is -1.
    
    See Also:
    
    Constant Field Values
  - ONLINE_CONFIGURATION_SHOW_NEITHER_USHER_CODE_OR_TOTP_CODE
```
public static final int ONLINE_CONFIGURATION_SHOW_NEITHER_USHER_CODE_OR_TOTP_CODE
```
    Server configuration for not showing either MicroStrategy Badge code of time-based one-time password (TOTP). Value is 0.
    
    See Also:
    
    Constant Field Values
  - ONLINE_CONFIGURATION_SHOW_TOTP_CODE
```
public static final int ONLINE_CONFIGURATION_SHOW_TOTP_CODE
```
    Server configuration for showing the time-based one-time password (TOTP). Value is 1.
    
    See Also:
    
    Constant Field Values
  - ONLINE_CONFIGURATION_SHOW_USHER_CODE
```
public static final int ONLINE_CONFIGURATION_SHOW_USHER_CODE
```
    Server configuration for showing the MicroStrategy Badge code. Value is 2.
    
    See Also:
    
    Constant Field Values
  - BASIC_COLOR_BLUE
```
public static final java.lang.String BASIC_COLOR_BLUE
```
    Basic blue background color. Value is "#2E9ED2".
    
    See Also:
    
    Constant Field Values
  - BASIC_COLOR_RED
```
public static final java.lang.String BASIC_COLOR_RED
```
    Basic red background color. Value is "#910738".
    
    See Also:
    
    Constant Field Values
  - BASIC_COLOR_GREEN
```
public static final java.lang.String BASIC_COLOR_GREEN
```
    Basic green background color. Value is "#5DAD43".
    
    See Also:
    
    Constant Field Values
  - BASIC_COLOR_GRAY
```
public static final java.lang.String BASIC_COLOR_GRAY
```
    Basic gray background color. Value is "#3C3C3C".
    
    See Also:
    
    Constant Field Values
  - BASIC_COLOR_PURPLE
```
public static final java.lang.String BASIC_COLOR_PURPLE
```
    Basic purple background color. Value is "#7E4BA6".
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BADGE_TEXT_COLOR
```
public static final java.lang.String DEFAULT_BADGE_TEXT_COLOR
```
    Default badge text color. Value is "#FFFFFF".
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BADGE_BACKGROUND_COLOR
```
public static final java.lang.String DEFAULT_BADGE_BACKGROUND_COLOR
```
    Default badge background color. Value is "#2E9ED2".
    
    See Also:
    
    Constant Field Values
  - DEFAULT_USHER_CODE_ONLINE_DURATION
```
public static final int DEFAULT_USHER_CODE_ONLINE_DURATION
```
    Default duration in seconds a MicroStrategy Badge code will last before expiring when the device is connected to a network. Value is 60.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_USHER_CODE_OFFLINE_DURATION
```
public static final int DEFAULT_USHER_CODE_OFFLINE_DURATION
```
    Default duration in seconds a MicroStrategy Badge code will last before expiring when the device is not connected to a network. Value is 60.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TOTP_CODE_DURATION
```
public static final int DEFAULT_TOTP_CODE_DURATION
```
    Default duration in seconds a time-based one-time password (TOTP) will last before expiring. Value is 60.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_USHER_CODE_VERSION
```
public static final int DEFAULT_USHER_CODE_VERSION
```
    Default MicroStrategy Badge code version. Value is 3.
    
    See Also:
    
    Constant Field Values
  - NEW_USHER_CODE_VERSION
```
public static final int NEW_USHER_CODE_VERSION
```
    New MicroStrategy Badge code version. Value is 5.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - orgId
```
public abstract int orgId()
```
    Returns an int of the identification number of the organization.
    
    Returns:
    
    the identification number of the organization.
  - showGradient
```
public abstract boolean showGradient()
```
    Returns a boolean that represents whether or not a gradient should be shown on the background color of the badge.
    
    Returns:
    
    true if the gradient should be shown on the background of the badge; false otherwise.
  - reportScannedData
```
public abstract boolean reportScannedData()
```
    Returns a boolean that represents whether or not scanned data should be reported to the server.
    
    Returns:
    
    true if scanned data should be reported to the server; false otherwise.
  - passcodeEnabled
```
public abstract boolean passcodeEnabled()
```
    Returns a boolean that represents whether or not a passcode is required.
    
    Returns:
    
    true if a passcode is required; false otherwise.
  - showPrivacyLink
```
public abstract boolean showPrivacyLink()
```
    Returns a boolean that represents whether or not the link to the privacy policy should be shown.
    
    Returns:
    
    true if the link to the privacy policy should be shown; false otherwise.
  - showTermOfUseLink
```
public abstract boolean showTermOfUseLink()
```
    Returns a boolean that represents whether or not the link to the terms of use should be shown.
    
    Returns:
    
    true if the link to the terms of use should be shown; false otherwise.
  - fingerprintEnabled
```
public abstract boolean fingerprintEnabled()
```
    Returns a boolean that represents whether or not fingerprint authentication is required.
    
    Returns:
    
    true if fingerprint authentication is required; false otherwise.
  - locationTrackingConfig
```
public abstract OrgUIEntity.LocationTrackingConfig locationTrackingConfig()
```
    Returns a OrgUIEntity.LocationTrackingConfig that represents the requirement for location reporting.
    Returns:
    the requirement for location reporting. These include:
    
    NONE
    
    WHILE_IN_USE
    
    ALWAYS
  - usherCodeOnlineDuration
```
public abstract int usherCodeOnlineDuration()
```
    Returns an int of the duration in seconds a MicroStrategy Badge code will last before expiring when the device is connected to a network.
    Returns:
    the duration in seconds a MicroStrategy Badge code will last before expiring when the device is connected to a network. The default MicroStrategy Badge code duration while online is:
    
    DEFAULT_USHER_CODE_ONLINE_DURATION = 60
  - usherCodeOfflineDuration
```
public abstract int usherCodeOfflineDuration()
```
    Returns an int of the duration in seconds a MicroStrategy Badge code will last before expiring when the device is not connected to a network.
    Returns:
    the duration in seconds a MicroStrategy Badge code will last before expiring when the device is not connected to a network. The default MicroStrategy Badge code duration while offline is:
    
    DEFAULT_USHER_CODE_OFFLINE_DURATION = 60
  - codeDisplayType
```
public abstract int codeDisplayType()
```
    Returns an int of the type of code a badge should display.
    Returns:
    the type of code a badge should display. These include:
    
    ONLINE_CONFIGURATION_SHOW_NEITHER_USHER_CODE_OR_TOTP_CODE = 0
    
    ONLINE_CONFIGURATION_SHOW_TOTP_CODE = 1
    
    ONLINE_CONFIGURATION_SHOW_USHER_CODE = 2
  - totpCodeDuration
```
public abstract int totpCodeDuration()
```
    Returns an int of the duration in seconds a time-based one-time password (TOTP) will last before expiring.
    Returns:
    the duration in seconds a time-based one-time password (TOTP) will last before expiring. The default TOTP duration is:
    
    DEFAULT_TOTP_CODE_DURATION = 60
  - usherCodeVersion
```
public abstract int usherCodeVersion()
```
    Returns an int of the MicroStrategy Badge code version for badges.
    Returns:
    the MicroStrategy Badge code version for badges. These include:
    
    DEFAULT_USHER_CODE_VERSION = 3 = 4 digits
    
    NEW_USHER_CODE_VERSION = 5 = 8 digits
  - orgName
```
@Nullable
public abstract java.lang.String orgName()
```
    Returns a String of the name of the organization. May be null.
    
    Returns:
    
    the name of the organization.
  - orgIconUrl
```
@Nullable
public abstract java.lang.String orgIconUrl()
```
    Returns a String of the URL of the organization icon. May be null.
    
    Returns:
    
    the URL of the organization icon.
  - orgIconCheckSum
```
@Nullable
public abstract java.lang.String orgIconCheckSum()
```
    Returns a String of the checksum of the organization icon. May be null.
    
    Returns:
    
    the checksum of the organization icon.
  - badgeName
```
@Nullable
public abstract java.lang.String badgeName()
```
    Returns a String of the name of the badge. May be null.
    
    Returns:
    
    the name of the badge.
  - textColor
```
@Nullable
public abstract java.lang.String textColor()
```
    Returns a String of the text color of badges. May be null.
    Returns:
    the text color of badges. The default text color is:
    
    DEFAULT_BADGE_TEXT_COLOR = "#FFFFFF"
  - backgroundImageUrl
```
@Nullable
public abstract java.lang.String backgroundImageUrl()
```
    Returns a String of the URL of the background image. May be null.
    
    Returns:
    
    the URL of the background image.
  - backgroundImageUrlCheckSum
```
@Nullable
public abstract java.lang.String backgroundImageUrlCheckSum()
```
    Returns a String of the checksum of the URL of the background image. May be null.
    
    Returns:
    
    the checksum of the URL of the background image.
  - backgroundColor
```
@Nullable
public abstract java.lang.String backgroundColor()
```
    Returns a String of the background color of badges. May be null.
    Returns:
    the background color of badges. The default background color is:
    
    DEFAULT_BADGE_BACKGROUND_COLOR = "#2E9ED2"
  - privacyPolicyLink
```
@Nullable
public abstract java.lang.String privacyPolicyLink()
```
    Returns a String of the address of the privacy policy. May be null.
    
    Returns:
    
    the address of the privacy policy.
  - termOfUseLink
```
@Nullable
public abstract java.lang.String termOfUseLink()
```
    Returns a String of the address of the terms of use. May be null.
    
    Returns:
    
    the address of the terms of use.
  - withOrgName
```
public abstract OrgUIEntity withOrgName(java.lang.String orgName)
```
    Constructor for an OrgUIEntity object with the orgName set.
    
    Parameters:
    
    orgName - the name of the organization
    
    Returns:
    
    an OrgUIEntity object with the orgName set.
  - toString
```
public java.lang.String toString()
```
    Returns a String of the organization ID and the name of the organization.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the organization ID and the name of the organization.

Class OrgUIEntity

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LEGACY_CONFIGURATION_SHOW_USHER_CODE

ONLINE_CONFIGURATION_SHOW_NEITHER_USHER_CODE_OR_TOTP_CODE

ONLINE_CONFIGURATION_SHOW_TOTP_CODE

ONLINE_CONFIGURATION_SHOW_USHER_CODE

BASIC_COLOR_BLUE

BASIC_COLOR_RED

BASIC_COLOR_GREEN

BASIC_COLOR_GRAY

BASIC_COLOR_PURPLE

DEFAULT_BADGE_TEXT_COLOR

DEFAULT_BADGE_BACKGROUND_COLOR

DEFAULT_USHER_CODE_ONLINE_DURATION

DEFAULT_USHER_CODE_OFFLINE_DURATION

DEFAULT_TOTP_CODE_DURATION

DEFAULT_USHER_CODE_VERSION

NEW_USHER_CODE_VERSION

Method Detail

orgId

showGradient

reportScannedData

passcodeEnabled

showPrivacyLink

showTermOfUseLink

fingerprintEnabled

locationTrackingConfig

usherCodeOnlineDuration

usherCodeOfflineDuration

codeDisplayType

totpCodeDuration

usherCodeVersion

orgName

orgIconUrl

orgIconCheckSum

badgeName

textColor

backgroundImageUrl

backgroundImageUrlCheckSum

backgroundColor

privacyPolicyLink

termOfUseLink

withOrgName

toString