com.microstrategy.usher

Class BadgeIdOrgIdEntity

java.lang.Object

com.microstrategy.usher.BadgeIdOrgIdEntity

public abstract class BadgeIdOrgIdEntity
extends java.lang.Object

The BadgeIdOrgIdEntity abstract class wraps a badge ID with an organization ID, along with certain other attributes pertaining to an organization. Two BadgeIdOrgIdEntity objects are considered equal if their badgeId() and orgId() are the same.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CREATED_AT Default badge creation time in milliseconds.
static int	DEFAULT_RECOVERED_AT Default badge recovery time in milliseconds.
static int	DEFAULT_SORT_ORDER Default sort order.
static int	INVALID_BADGE_ID Invalid badge ID.
static int	INVALID_ORG_ID Invalid organization ID.

Method Summary

Modifier and Type	Method and Description
abstract int	badgeId() Returns an int of the identification number of the badge.
abstract long	createdAt() Returns a long of the time in milliseconds at which the badge was created in an organization.
abstract java.lang.String	credential() Returns a String of the credentials associated with the badge within an organization.
abstract int	orgId() Returns an int of the identification number of the organization.
abstract long	recoveredAt() Returns a long of the time in milliseconds at which the badge was recovered in an organization.
abstract long	sortOrder() Returns a long of the sort order of badges in an organization.
abstract BadgeIdOrgIdEntity	withCredential(java.lang.String credential) Returns a BadgeIdOrgIdEntity object with an added credential() attribute.
abstract BadgeIdOrgIdEntity	withRecoveredAt(long recoveredAt) Returns a BadgeIdOrgIdEntity object with an added recoveredAt() attribute.
abstract BadgeIdOrgIdEntity	withSortOrder(long sortOrder) Returns a BadgeIdOrgIdEntity object with an added sortOrder() attribute.

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_ORG_ID

public static final int INVALID_ORG_ID

Invalid organization ID. Value is -2147483648.

See Also:

Constant Field Values

INVALID_BADGE_ID

public static final int INVALID_BADGE_ID

Invalid badge ID. Value is -2147483648.

See Also:

Constant Field Values

DEFAULT_CREATED_AT

public static final int DEFAULT_CREATED_AT

Default badge creation time in milliseconds. Value is 0.

See Also:

Constant Field Values

DEFAULT_RECOVERED_AT

public static final int DEFAULT_RECOVERED_AT

Default badge recovery time in milliseconds. Value is 0.

See Also:

Constant Field Values

DEFAULT_SORT_ORDER

public static final int DEFAULT_SORT_ORDER

Default sort order. Value is 0.

See Also:

Constant Field Values

Method Detail

badgeId

public abstract int badgeId()

Returns an int of the identification number of the badge.

Returns:

the identification number of the badge.

orgId

public abstract int orgId()

Returns an int of the identification number of the organization.

Returns:

the identification number of the organization.

credential

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

Returns a String of the credentials associated with the badge within an organization. The credentials are supplied after a successful login of the badge.

Returns:

the credentials associated with the badge within an organization.

sortOrder

public abstract long sortOrder()

Returns a long of the sort order of badges in an organization. By default, the sort order is DEFAULT_SORT_ORDER = 0.

Returns:

the sort order of badges in an organization.

createdAt

public abstract long createdAt()

Returns a long of the time in milliseconds at which the badge was created in an organization.

Returns:

the time in milliseconds at which the badge was created in an organization.

recoveredAt

public abstract long recoveredAt()

Returns a long of the time in milliseconds at which the badge was recovered in an organization.

Returns:

the time in milliseconds at which the badge was recovered in an organization.

withSortOrder

public abstract BadgeIdOrgIdEntity withSortOrder(long sortOrder)

Returns a BadgeIdOrgIdEntity object with an added sortOrder() attribute.

Parameters:

sortOrder - the sort order of badges in an organization

Returns:

a BadgeIdOrgIdEntity object with an added sortOrder() attribute.

withCredential

public abstract BadgeIdOrgIdEntity withCredential(java.lang.String credential)

Returns a BadgeIdOrgIdEntity object with an added credential() attribute.

Parameters:

credential - the credentials associated with the badge within an organization

Returns:

a BadgeIdOrgIdEntity object with an added credential() attribute.

withRecoveredAt

public abstract BadgeIdOrgIdEntity withRecoveredAt(long recoveredAt)

Returns a BadgeIdOrgIdEntity object with an added recoveredAt() attribute.

Parameters:

recoveredAt - the time in milliseconds at which the badge was recovered in an organization

Returns:

a BadgeIdOrgIdEntity object with an added recoveredAt() attribute.