com.microstrategy.usher

Class KeyEntity

java.lang.Object

com.microstrategy.usher.KeyEntity

public abstract class KeyEntity
extends java.lang.Object

The KeyEntity abstract class wraps various attributes related to a key. Keys can be made a favorite key to make them easier to find. When tapped, a group key will show all the individual keys in the group. When tapped, a batch key will activate all the individual keys in the batch at the same time.

Method Summary

Modifier and Type	Method and Description
boolean	areContentsTheSame(KeyEntity keyEntity) Returns a boolean that represents whether or not the contents of two keys are the same.
boolean	areItemsTheSame(KeyEntity keyEntity) Returns a boolean that represents whether or not the items of two keys are the same.
abstract int	badgeId() Returns an int of the identification number of the badge the key belongs to.
abstract boolean	favoriteKey() Returns a boolean that represents whether or not the key is a favorite key.
abstract GroupKeyEntity	groupKeyEntity() Returns a GroupKeyEntity object related to the key.
abstract int	keyId() Returns an int of the identification number of the key.
abstract int	keyOrder() Returns an int of the sort order of keys.
abstract java.lang.String	name() Returns a String of the name of the key.
abstract KeyEntity	withFavoriteKey(boolean favoriteKey) Constructor for a KeyEntity object with the favoriteKey set.

Methods inherited from class java.lang.Object

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

Method Detail

areContentsTheSame

public boolean areContentsTheSame(KeyEntity keyEntity)

Returns a boolean that represents whether or not the contents of two keys are the same. Two keys have the same content if they have the same name and are both a favorite key.

Parameters:

keyEntity - See KeyEntity

Returns:

true if the two keys have the same name and are both a favorite key; false otherwise.

areItemsTheSame

public boolean areItemsTheSame(KeyEntity keyEntity)

Returns a boolean that represents whether or not the items of two keys are the same. Two keys have the same items if they have the same key ID.

Parameters:

keyEntity - See KeyEntity

Returns:

true if the two keys have the same key ID; false otherwise.

keyId

public abstract int keyId()

Returns an int of the identification number of the key. Used in the Object.hashCode() and Object.equals(Object) implementations.

Returns:

the identification number of the key.

badgeId

public abstract int badgeId()

Returns an int of the identification number of the badge the key belongs to.

Returns:

the identification number of the badge the key belongs to.

name

public abstract java.lang.String name()

Returns a String of the name of the key.

Returns:

the name of the key.

favoriteKey

public abstract boolean favoriteKey()

Returns a boolean that represents whether or not the key is a favorite key.

Returns:

true if the key is a favorite key; false otherwise.

keyOrder

public abstract int keyOrder()

Returns an int of the sort order of keys.

Returns:

the sort order of keys.

withFavoriteKey

public abstract KeyEntity withFavoriteKey(boolean favoriteKey)

Constructor for a KeyEntity object with the favoriteKey set.

Parameters:

favoriteKey - See favoriteKey()

Returns:

a KeyEntity object with the favoriteKey set.

groupKeyEntity

@Nullable
public abstract GroupKeyEntity groupKeyEntity()

Returns a GroupKeyEntity object related to the key. Only keys that are part of a group key will have this property. May be null.

Returns:

a GroupKeyEntity object related to the key.