nl.gx.webmanager.cms.form
Interface RuleParameter


public interface RuleParameter

A RuleParameter object describes a specific value set as a parameter to handler. A rule parameter object can stored different types of values. Consult the rule parameter model to find the correct type of this parameter. Some parameters are multivalued. For each parameter data type there is a version of the accessor method which returns an array for that datatype.

Author:
simon

Method Summary
 boolean getBoolean()
          Return the value of this parameter as a boolean.
 boolean[] getBooleans()
          Return the boolean values of this multivalued parameter.
 Form getForm()
          Return the page value of this parameter.
 FormPart getFormPart()
          Return the formpart value of this parameter.
 FormPart[] getFormParts()
          Return the selected formpart objects of this multivalued parameter.
 Form[] getForms()
          Return the selected forms of this multivalued parameter.
 int getInteger()
          Return the value of this parameter as an integer.
 int[] getIntegers()
          Return the integer values of this multivalued parameter.
 Page getPage()
          Return the page value of this parameter.
 Page[] getPages()
          Return the selected pages of this multivalued parameter.
 RuleParameterModel getParameterModel()
          Return the matching rule parameter model for this parameter.
 java.lang.String getString()
          Return the value of this parameter as string value.
 java.lang.String[] getStrings()
          Return the string values of this multivalued parameter.
 

Method Detail

getParameterModel

RuleParameterModel getParameterModel()
Return the matching rule parameter model for this parameter.

Returns:
the rule model for this parameter.

getString

java.lang.String getString()
Return the value of this parameter as string value.

Returns:
the value of this parameter as a string.

getStrings

java.lang.String[] getStrings()
Return the string values of this multivalued parameter.

Returns:
the array of string values.

getBoolean

boolean getBoolean()
Return the value of this parameter as a boolean.

Returns:
the value as a boolean

getBooleans

boolean[] getBooleans()
Return the boolean values of this multivalued parameter.

Returns:
the array of boolean values.

getInteger

int getInteger()
Return the value of this parameter as an integer.

Returns:
the value as an integer.

getIntegers

int[] getIntegers()
Return the integer values of this multivalued parameter.

Returns:
the array of integer values.

getPage

Page getPage()
Return the page value of this parameter.

Returns:
the selected page object

getPages

Page[] getPages()
Return the selected pages of this multivalued parameter.

Returns:
the array of page objects.

getForm

Form getForm()
Return the page value of this parameter.

Returns:
the selected form object

getForms

Form[] getForms()
Return the selected forms of this multivalued parameter.

Returns:
the array of form objects.

getFormPart

FormPart getFormPart()
Return the formpart value of this parameter.

Returns:
the selected formpart object

getFormParts

FormPart[] getFormParts()
Return the selected formpart objects of this multivalued parameter.

Returns:
the array of formpart objects.


Copyright © 2007-2011 GX Software BV. All Rights Reserved.