public class

EventArgumentInfo

extends AbstractConfigurationElement
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.web.beans.EventArgumentInfo

Class Overview

This class represents the "argument" node from the XML. Each argument is identified by its id. This is the deepest node in the xml and does not contain any child nodes Children : None. Attributes: "id" - The argument id "name" - The name of the argument "required" - // 0: not required // 1: required // 2+: required (group number) Key : "id" attribute.

Summary

Constants
String ATT_ID
String ATT_INDEX
String ATT_NAME
String ATT_REQUIRED
String ATT_TYPE
String ATT_VALIDATOR
String ATT_VALUE
String NODE_EVENT_ARGUMENT
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
EventArgumentInfo()
Default constructor.
EventArgumentInfo(int id)
Constructor: Set the id field for the argument
EventArgumentInfo(int id, String name)
Set the id and name for the argument
Public Methods
int getID()
Return the id field value.
String getName()
Returns the name attribute.
int getRequiredGroup()
Returns the "required" attribute value.
String getType()
Returns the type attribute.
String getValidator()
Returns the validator attribute.
String getValue()
Returns the value attribute.
boolean isRequired()
Returns true if the required-group value is different from 0 (i.e.
void setID(int id)
Set the id field value
void setName(String name)
Set the name field value
void setRequiredGroup(int required)
Set the required field value
void setType(String type)
Set the type field value
void setValidator(String validator)
Set the validator field value
void setValue(String value)
Sets the value attribute.
Protected Methods
String getKeyAttribute()
This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.
[Expand]
Inherited Methods
From class com.microstrategy.utils.config.AbstractConfigurationElement
From class java.lang.Object
From interface com.microstrategy.utils.config.ConfigurationElement
From interface com.microstrategy.utils.config.ConfigurationFile

Constants

public static final String ATT_ID

Constant Value: "id"

public static final String ATT_INDEX

Constant Value: "index"

public static final String ATT_NAME

Constant Value: "name"

public static final String ATT_REQUIRED

Constant Value: "required"

public static final String ATT_TYPE

Constant Value: "type"

public static final String ATT_VALIDATOR

Constant Value: "validator"

public static final String ATT_VALUE

Constant Value: "value"

public static final String NODE_EVENT_ARGUMENT

Constant Value: "argument"

Public Constructors

public EventArgumentInfo ()

Default constructor. Set the node name and register the child element

public EventArgumentInfo (int id)

Constructor: Set the id field for the argument

Parameters
id The argument "id" for this object

public EventArgumentInfo (int id, String name)

Set the id and name for the argument

Parameters
id The argument "id" for this object
name The argument "name" for this object

Public Methods

public int getID ()

Return the id field value.

Returns
  • The "id" associated with this argument

public String getName ()

Returns the name attribute. This will be used as the name of the URL paramter associated with this attribute.

public int getRequiredGroup ()

Returns the "required" attribute value. This attribute identifies when the value of an attribute is required for the correct execution of the event. The possible values are:

  • 0: not required (default).
  • 1: always required.
  • 2+: required within a group. When several attributes shared the same "required" value, at least one of these attributes needs to be assigned a non-null value.

public String getType ()

Returns the type attribute. This will be used as the data type of the parameter associated with this attribute.

Returns
  • type

public String getValidator ()

Returns the validator attribute. This will be used as the data type validator of the parameter associated with this attribute.

Returns
  • type

public String getValue ()

Returns the value attribute. This will be used as the default for this argument.

public boolean isRequired ()

Returns true if the required-group value is different from 0 (i.e. it is required for this attribute to be in the request).

public void setID (int id)

Set the id field value

Parameters
id The new value for the "id" attribute

public void setName (String name)

Set the name field value

Parameters
name The new value for the "name" attribute

public void setRequiredGroup (int required)

Set the required field value

Parameters
required The new value for the "required" attribute

public void setType (String type)

Set the type field value

public void setValidator (String validator)

Set the validator field value

public void setValue (String value)

Sets the value attribute. This will be sued as the default value for this argument.

Protected Methods

protected String getKeyAttribute ()

This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.