Package com.microstrategy.web.beans
Interface WebEvent.Argument
-
- Enclosing interface:
- WebEvent
public static interface WebEvent.Argument
TheArgument
interface represents aWebEvent
argument. An event argument informs an event handler what has been changed after an event occurs and thus instructs the event handler what appropriate actions to do.Within an event, an event argument has a unique identifier which is the key bridging the
RequestKeys
object and theWebEventHandler
object. An event handler uses this argument id to obtain the agument name and the argument value from theRequestKeys
object.If an argument is required, it must be present in the
RequestKeys
.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getID()
Returns the ID of this argument.int
getIndex()
Returns the index of this argument.java.lang.String
getName()
Returns the name of this argument.int
getRequired()
Returns the required group number: 0 = not required, 1 = required, 2+ = required (group number).java.lang.String
getType()
Returns the type of this argument.java.lang.String
getValidator()
Returns the validator of this argument.java.lang.String
getValue()
Returns the value of this argument.boolean
isRequired()
Returns true if this argument is a required argument for an event.
-
-
-
Method Detail
-
getID
int getID()
Returns the ID of this argument. This ID is unique within the event to which this argument belongs.- Returns:
- the unique ID of this argument.
-
getName
java.lang.String getName()
Returns the name of this argument.- Returns:
- the name of this argument.
-
isRequired
boolean isRequired()
Returns true if this argument is a required argument for an event. A required argument is the one that an event handler will be expecting to receive from an event.- Returns:
- true if this argument is required.
-
getRequired
int getRequired()
Returns the required group number: 0 = not required, 1 = required, 2+ = required (group number). If the value returned is 2 or greater, it belongs to a group of arguments, where at least one of the arguments must be specified.- Returns:
- the required group number.
- Since:
- MicroStrategy Web 8.0.0
-
getValue
java.lang.String getValue()
Returns the value of this argument. An argument could possibly have an initial value in the event definition, and the caller has perfect reason to change the value at the run time.- Returns:
- the value of this argument.
-
getIndex
int getIndex()
Returns the index of this argument. An index can assist an application to put two arguments with the same name and id, but with different index, within the same Web page.- Returns:
- the index of this argument.
-
getType
java.lang.String getType()
Returns the type of this argument.- Returns:
- the type of this argument.
-
getValidator
java.lang.String getValidator()
Returns the validator of this argument.- Returns:
- the validator of this argument.
-
-