| com.microstrategy.web.beans.WebEvent.Argument |
The Argument interface represents a WebEvent 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 the WebEventHandler object. An event
handler uses this argument id to obtain the agument name and the argument value from
the RequestKeys object.
If an argument is required, it must be present in the RequestKeys.
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract int |
getID()
Returns the ID of this argument.
| ||||||||||
| abstract int |
getIndex()
Returns the index of this argument.
| ||||||||||
| abstract String |
getName()
Returns the name of this argument.
| ||||||||||
| abstract int |
getRequired()
Returns the required group number: 0 = not required, 1 = required,
2+ = required (group number).
| ||||||||||
| abstract String |
getType()
Returns the type of this argument.
| ||||||||||
| abstract String |
getValidator()
Returns the validator of this argument.
| ||||||||||
| abstract String |
getValue()
Returns the value of this argument.
| ||||||||||
| abstract boolean |
isRequired()
Returns true if this argument is a required argument for an event.
| ||||||||||
Returns the ID of this argument. This ID is unique within the event to which this argument belongs.
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 name of this argument.
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 type of this argument.
Returns the validator of this argument.
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 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.