public static class

GenericEventHandler.GenericEventKeys

extends GenericRequestKeys
java.lang.Object
   ↳ com.microstrategy.web.beans.GenericRequestKeys
     ↳ com.microstrategy.web.beans.GenericEventHandler.GenericEventKeys

Class Overview

This inner class is an implementation of the request keys specific for an event. The collection contains the keys for a particular event.

Summary

Protected Constructors
GenericEventHandler.GenericEventKeys(RequestKeys keys, int eventId)
Public Methods
String getValue(String keyName)
Returns from this collection a comma separated string of all the values mapped by the specified keyName.
String getValue(String keyName, int valueIndex)
Returns the value at the specified position mapped by the specified keyName.
int getValueCount(String keyName)
Returns from this collection the number of values mapped with the keyName.
Object getValueObject(String keyName, int valueIndex)
Returns the Object at the specified position mapped by the specified keyName.
Enumeration getValueObject(String key)
Returns the collection of all the values mapped by the specified keyName.
Protected Methods
boolean canAddKey(String name)
This method is called during the initializeRequestKeys() method before adding the keys to the collection.
int getEventId()
Method returns the event Id used for creating this collection.
RequestKeys getOriginalKeys()
Method returns the request keys used for creating this collection.
void initializeRequestKeys()
Initializes the collection with the values from the Request and/or Session, according to what was specified by the keySpace.
[Expand]
Inherited Methods
From class com.microstrategy.web.beans.GenericRequestKeys
From class java.lang.Object
From interface com.microstrategy.web.beans.RequestKeys

Protected Constructors

protected GenericEventHandler.GenericEventKeys (RequestKeys keys, int eventId)

Public Methods

public String getValue (String keyName)

Returns from this collection a comma separated string of all the values mapped by the specified keyName.

Parameters
keyName a key in this collection
Returns
  • all the values mapped to the keyName, separated by the character comma; null if the key does not exist.

public String getValue (String keyName, int valueIndex)

Returns the value at the specified position mapped by the specified keyName.

Parameters
keyName a key in this collection
valueIndex the index of a value mapped to the key specified
Returns
  • the value at the specified position mapped by the specified key; null if the key does not exist.

public int getValueCount (String keyName)

Returns from this collection the number of values mapped with the keyName.

Parameters
keyName a key to a value collection
Returns
  • the count of values to which the specified key is mapped in this collection; 0 if the key is not found.

public Object getValueObject (String keyName, int valueIndex)

Returns the Object at the specified position mapped by the specified keyName.

Parameters
keyName a key in this collection
valueIndex the index of an Object mapped to the key specified
Returns
  • the Object at the specified position mapped by the specified key; null if the key does not exist.

public Enumeration getValueObject (String key)

Returns the collection of all the values mapped by the specified keyName.

Parameters
key a key in this collection
Returns
  • all the values mapped to the keyName; null if the key does not exist.

Protected Methods

protected boolean canAddKey (String name)

This method is called during the initializeRequestKeys() method before adding the keys to the collection.

Parameters
name - key name to check
Returns
  • true if the key

protected int getEventId ()

Method returns the event Id used for creating this collection.

protected RequestKeys getOriginalKeys ()

Method returns the request keys used for creating this collection.

protected void initializeRequestKeys ()

Initializes the collection with the values from the Request and/or Session, according to what was specified by the keySpace.