com.microstrategy.usher

Class BadgeUIEntity

java.lang.Object

com.microstrategy.usher.BadgeUIEntity

public abstract class BadgeUIEntity
extends java.lang.Object

The BadgeUIEntity abstract class wraps various attributes about the presentation of a badge, including organization name, employee name, and employee title, among others.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROFILE_IMAGE_URL The URL base for the image URL.

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	defaultEnrolledPhoneNumber() Returns a String of the default enrolled mobile phone number.
abstract java.lang.String	emailAddress() Returns a String of the email address of the employee.
abstract java.lang.String	employeeFullName() Returns a String of the full name of the employee.
abstract java.lang.String	employeeNameInitial() Returns a String of the initials of the employee name.
abstract java.lang.String	employeeTitle() Returns a String of the title of the employee.
static java.lang.String	imageUrl(int senderBadgeId) Returns a String of the full image URL.
abstract java.lang.String	orgName() Returns a String of the name of the organization.
abstract java.lang.String	profilePhotoChecksum() Returns a String of the checksum of the profile photo.
abstract java.lang.String	profilePhotoUrl() Returns a String of the URL of the profile photo.
java.lang.String	toString() Returns a String of the full name of the employee.

Methods inherited from class java.lang.Object

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

Field Detail

PROFILE_IMAGE_URL

public static final java.lang.String PROFILE_IMAGE_URL

The URL base for the image URL.

See Also:

Constant Field Values

Method Detail

imageUrl

public static java.lang.String imageUrl(int senderBadgeId)

Returns a String of the full image URL.

Parameters:

senderBadgeId - the identification number of the badge for which the image is requested

Returns:

the full image URL

defaultEnrolledPhoneNumber

@Nullable
public abstract java.lang.String defaultEnrolledPhoneNumber()

Returns a String of the default enrolled mobile phone number. May be null.

Returns:

the default enrolled mobile phone number.

profilePhotoUrl

@Nullable
public abstract java.lang.String profilePhotoUrl()

Returns a String of the URL of the profile photo. May be null.

Returns:

the URL of the profile photo.

profilePhotoChecksum

@Nullable
public abstract java.lang.String profilePhotoChecksum()

Returns a String of the checksum of the profile photo. May be null.

Returns:

the checksum of the profile photo.

employeeNameInitial

@Nullable
public abstract java.lang.String employeeNameInitial()

Returns a String of the initials of the employee name. May be null.

Returns:

the initials of the employee name.

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.

employeeFullName

@Nullable
public abstract java.lang.String employeeFullName()

Returns a String of the full name of the employee. May be null.

Returns:

the full name of the employee.

employeeTitle

@Nullable
public abstract java.lang.String employeeTitle()

Returns a String of the title of the employee. May be null.

Returns:

the title of the employee.

emailAddress

@Nullable
public abstract java.lang.String emailAddress()

Returns a String of the email address of the employee. May be null.

Returns:

the email address of the employee.

toString

@Nullable
public java.lang.String toString()

Returns a String of the full name of the employee. May be null.

Overrides:

toString in class java.lang.Object

Returns:

the full name of the employee.