com.microstrategy.usher

Class KeyModel

java.lang.Object

com.microstrategy.usher.KeyModel

public abstract class KeyModel
extends java.lang.Object

The KeyModel abstract class wraps the core attributes pertaining to the key found in a KeyEntity with other more dynamic attributes, such as the organization ID and key color.

Method Summary

Modifier and Type	Method and Description
boolean	areContentsTheSame(KeyModel newItem) Returns a boolean that represents whether or not the contents of two keys are the same.
boolean	areItemsTheSame(KeyModel otherKeyModel) 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.
abstract java.lang.String	badgeName() Returns a String of the name of the badge.
abstract java.lang.String	keyColor() Returns a String of the color of the key.
abstract KeyEntity	keyEntity() Returns the KeyEntity object that wraps the core attributes pertaining to the key.
abstract int	localKeyOrder() Returns an int of the key sort order on the device.
abstract int	orgId() Returns an int of the identification number of the organization.
abstract java.lang.String	serverUrl() Returns a String of the URL of the server
abstract KeyModel	withKeyEntity(KeyEntity keyEntity) Constructor for a KeyModel object with the keyEntity set.

Methods inherited from class java.lang.Object

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

Method Detail

keyEntity

public abstract KeyEntity keyEntity()

Returns the KeyEntity object that wraps the core attributes pertaining to the key. Used in the Object.hashCode() and Object.equals(Object) implementations.

Returns:

a KeyEntity object.

orgId

public abstract int orgId()

Returns an int of the identification number of the organization.

Returns:

the identification number of the organization.

badgeId

public abstract int badgeId()

Returns an int of the identification number of the badge.

Returns:

the identification number of the badge.

badgeName

public abstract java.lang.String badgeName()

Returns a String of the name of the badge.

Returns:

the name of the badge.

keyColor

public abstract java.lang.String keyColor()

Returns a String of the color of the key.

Returns:

the color of the key.

serverUrl

public abstract java.lang.String serverUrl()

Returns a String of the URL of the server

Returns:

the URL of the server.

localKeyOrder

public abstract int localKeyOrder()

Returns an int of the key sort order on the device.

Returns:

the key sort order on the device.

withKeyEntity

public abstract KeyModel withKeyEntity(KeyEntity keyEntity)

Constructor for a KeyModel object with the keyEntity set.

Parameters:

keyEntity - See KeyEntity

Returns:

a KeyModel object with the keyEntity set.

areContentsTheSame

public boolean areContentsTheSame(KeyModel newItem)

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:

newItem - See KeyModel

Returns:

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

areItemsTheSame

public boolean areItemsTheSame(KeyModel otherKeyModel)

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:

otherKeyModel - See KeyModel

Returns:

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