com.ibm.as400.webaccess.util
Class ServletParameter

java.lang.Object
  |
  +--com.ibm.as400.webaccess.util.ServletParameter

public final class ServletParameter
extends java.lang.Object

Represents a parameter URI for a WebAccess servlet.


Constructor Summary
ServletParameter(java.lang.String uri, boolean required, java.lang.String titleKey, java.lang.String descriptionKey)
           
ServletParameter(java.lang.String uri, boolean required, java.lang.String titleKey, java.lang.String descriptionKey, ServletParameterValue[] values)
           
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 ServletParameterValue getDefaultValue()
          Returns the default value for this parameter, or null if there is no default value or there is no finite list of valid values.
 java.lang.String getDescription(java.util.ResourceBundle bundle)
          Returns the translated description for this parameter.
 java.lang.String getTitle(java.util.ResourceBundle bundle)
          Returns the translated title name for this parameter.
 java.lang.String getURI()
          Returns the URI string for this parameter, e.g.
 ServletParameterValue getValue(java.lang.String uri)
          Returns the valid value with the specified URI, or null if no matching URI was found or if this parameter does not have a defined list of valid values.
 ServletParameterValue[] getValues()
          Returns the list of valid values for this parameter, or an empty array if no valid values have been defined (indicating that any value is valid).
 boolean isRequired()
          Indicates if this parameter is required to be specified when generating a URL for its servlet.
 void setDefaultValue(ServletParameterValue value)
          Sets the default value.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ServletParameter

public ServletParameter(java.lang.String uri,
                        boolean required,
                        java.lang.String titleKey,
                        java.lang.String descriptionKey)

ServletParameter

public ServletParameter(java.lang.String uri,
                        boolean required,
                        java.lang.String titleKey,
                        java.lang.String descriptionKey,
                        ServletParameterValue[] values)
Method Detail

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

getDefaultValue

public ServletParameterValue getDefaultValue()
Returns the default value for this parameter, or null if there is no default value or there is no finite list of valid values.


getDescription

public java.lang.String getDescription(java.util.ResourceBundle bundle)
Returns the translated description for this parameter.


getTitle

public java.lang.String getTitle(java.util.ResourceBundle bundle)
Returns the translated title name for this parameter.


getURI

public java.lang.String getURI()
Returns the URI string for this parameter, e.g. "action".


getValue

public ServletParameterValue getValue(java.lang.String uri)
Returns the valid value with the specified URI, or null if no matching URI was found or if this parameter does not have a defined list of valid values.


getValues

public ServletParameterValue[] getValues()
Returns the list of valid values for this parameter, or an empty array if no valid values have been defined (indicating that any value is valid).


isRequired

public boolean isRequired()
Indicates if this parameter is required to be specified when generating a URL for its servlet.


setDefaultValue

public void setDefaultValue(ServletParameterValue value)
Sets the default value.