com.microstrategy.usher

Class GroupKeyEntity

java.lang.Object

com.microstrategy.usher.GroupKeyEntity

public abstract class GroupKeyEntity
extends java.lang.Object

The GroupKeyEntity abstract class wraps the grouped key items defined on Network Manager.

Method Summary

Modifier and Type	Method and Description
abstract java.util.List<GroupKeyItemEntity>	groupKeyItemEntity1() Returns the List of GroupKeyItemEntity objects related to group 1 of the the group key.
abstract java.util.List<GroupKeyItemEntity>	groupKeyItemEntity2() Returns the List of GroupKeyItemEntity objects related to group 2 of the the group key.
abstract java.util.List<GroupKeyItemEntity>	groupKeyItemEntity3() Returns the List of GroupKeyItemEntity objects related to group 3 of the the group key.
abstract boolean	isBatchKey() Returns a boolean that represents whether or not the GroupKeyEntity is a batch key (i.e.
abstract int	layoutCount() Returns an int of the layout count of the key.
abstract java.util.List<GroupKeyItemEntity>	totalGroupKeyItemEntityList() Returns the List of GroupKeyItemEntity objects related to the group key.

Methods inherited from class java.lang.Object

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

Method Detail

layoutCount

public abstract int layoutCount()

Returns an int of the layout count of the key. For keys in a group, the layout count dictates the positioning of keys within the columns in the layout.

Returns:

the layout count of the key.

totalGroupKeyItemEntityList

public abstract java.util.List<GroupKeyItemEntity> totalGroupKeyItemEntityList()

Returns the List of GroupKeyItemEntity objects related to the group key. This List includes all of the keys associated with a group key.

Returns:

a List of GroupKeyItemEntity objects related to a key.

groupKeyItemEntity1

public abstract java.util.List<GroupKeyItemEntity> groupKeyItemEntity1()

Returns the List of GroupKeyItemEntity objects related to group 1 of the the group key.

Returns:

a List of GroupKeyItemEntity objects related group 1 of the group key.

groupKeyItemEntity2

@Nullable
public abstract java.util.List<GroupKeyItemEntity> groupKeyItemEntity2()

Returns the List of GroupKeyItemEntity objects related to group 2 of the the group key. May be null.

Returns:

a List of GroupKeyItemEntity objects related group 2 of the group key.

groupKeyItemEntity3

@Nullable
public abstract java.util.List<GroupKeyItemEntity> groupKeyItemEntity3()

Returns the List of GroupKeyItemEntity objects related to group 3 of the the group key. May be null.

Returns:

a List of GroupKeyItemEntity objects related group 3 of the group key.

isBatchKey

public abstract boolean isBatchKey()

Returns a boolean that represents whether or not the GroupKeyEntity is a batch key (i.e. a key that can trigger multiple keys upon activation).

Returns:

true if the GroupKeyEntity is a batch key; false otherwise (i.e. the key is a group key).