Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.eclipse.birt.report.model.api
Class ScalarParameterHandle

    java.lang.Object
      org.eclipse.birt.report.model.api.DesignElementHandle
          org.eclipse.birt.report.model.api.ReportElementHandle
              org.eclipse.birt.report.model.api.ParameterHandle
                  org.eclipse.birt.report.model.api.AbstractScalarParameterHandle
                      org.eclipse.birt.report.model.api.ScalarParameterHandle

All Implemented Interfaces:
  org.eclipse.birt.report.model.elements.interfaces.IAbstractScalarParameterModel, org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel, org.eclipse.birt.report.model.elements.interfaces.IParameterModel, org.eclipse.birt.report.model.elements.interfaces.IScalarParameterModel

    public class ScalarParameterHandle

extends AbstractScalarParameterHandle
implements org.eclipse.birt.report.model.elements.interfaces.IScalarParameterModel

Represents a scalar (single-value) report parameter. If the user enters no value for a parameter, then the default value is used. If there is no default value, then BIRT checks if `null` is allowed. If so, the value of the parameter is null. If nulls are not allowed, then the user must enter a value.

Scalar parameters can have static or dynamic selection lists.

- The parameter static selection list provides a developer-defined list of choices. Every choice has two parts: a choice and a label. The label can be externalized and appears in the UI. The choice is the value passed to the report.
- This parameter can define a dynamic selection list for the parameter. The data set can reference other parameters by referring to a data set. The data set must return a column that contains the choice values. It may also contain a column that returns the labels for the values. All other columns are ignored.

See Also:
  `ScalarParameter`, `ParameterHandle`

Field Summary

Fields inherited from class org.eclipse.birt.report.model.api.ReportElementHandle
`element`

Fields inherited from class org.eclipse.birt.report.model.api.DesignElementHandle
`module`

Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IScalarParameterModel
`ALIGNMENT_PROP, ALLOW_BLANK_PROP, ALLOW_NULL_PROP, AUTO_SUGGEST_THRESHOLD_PROP, BOUND_DATA_COLUMNS_PROP, CONCEAL_VALUE_PROP, CONTROL_TYPE_PROP, FIXED_ORDER_PROP, FORMAT_PROP, GET_DEFAULT_VALUE_LIST_PROP, GET_SELECTION_VALUE_LIST_PROP, MUCH_MATCH_PROP, PARAM_TYPE_PROP`

Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IAbstractScalarParameterModel
`DATA_TYPE_PROP, DATASET_NAME_PROP, DEFAULT_VALUE_PROP, DISTINCT_PROP, IS_REQUIRED_PROP, LABEL_EXPR_PROP, LIST_LIMIT_PROP, SELECTION_LIST_PROP, SORT_BY_COLUMN_PROP, SORT_BY_PROP, SORT_DIRECTION_PROP, VALUE_EXPR_PROP, VALUE_TYPE_PROP`

Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IParameterModel
`HELP_TEXT_KEY_PROP, HELP_TEXT_PROP, HIDDEN_PROP, PROMPT_TEXT_ID_PROP, PROMPT_TEXT_PROP, VALIDATE_PROP`

Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel
`COMMENTS_PROP, CUSTOM_XML_PROP, DISPLAY_NAME_ID_PROP, DISPLAY_NAME_PROP, EVENT_HANDLER_CLASS_PROP, EXTENDS_PROP, FULL_LABEL, ID_SUFFIX, NAME_PROP, NEW_HANDLER_ON_EACH_EVENT_PROP, NO_SLOT, PROPERTY_MASKS_PROP, REF_TEMPLATE_PARAMETER_PROP, SHORT_LABEL, USER_LABEL, USER_PROPERTIES_PROP, VIEW_ACTION_PROP`

Constructor Summary
`ScalarParameterHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)` Constructs a handle for the ScalarParamter with the given design and the parameter.

Method Summary
`ComputedColumnHandle` | `addColumnBinding(ComputedColumn addColumn, boolean inForce)` Adds a bound column to the list.
`boolean` | `allowBlank()` Deprecated. by `AbstractScalarParameterHandle.isRequired()`
`boolean` | `allowNull()` Deprecated. by `AbstractScalarParameterHandle.isRequired()`
`java.util.Iterator` | `columnBindingsIterator()` Returns the bound columns that binds the data set columns.
`java.lang.String` | `getAlignment()` Returns the alignment for this parameter.
`int` | `getAutoSuggestThreshold()` Returns the maximal number of of entries a report parameter pick list can have.
`java.lang.String` | `getCategory()` Returns the category for the parameter format.
`PropertyHandle` | `getColumnBindings()` Get a handle to deal with the bound column.
`java.lang.String` | `getControlType()` Returns the control type for this parameter.
`java.lang.String` | `getDefaultValue()` Deprecated. since 2.5 replaced by `AbstractScalarParameterHandle.getDefaultValueList()`
`java.lang.String` | `getDefaultValueListMethod()` Gets the method content of `getDefaultValueList`.
`java.lang.String` | `getFormat()` Deprecated. replaced by getPattern and getCategory.
`java.lang.String` | `getLabelColumn()` Deprecated. Replaced by the method `AbstractScalarParameterHandle.getLabelExpr()`
`int` | `getListlimit()` get the list limited number.
`java.lang.String` | `getParamType()` Returns the parameter type for this scalar parameter.
`java.lang.String` | `getPattern()` Returns the pattern of format instructions for the parameter value.
`java.lang.Object` | `getProperty(java.lang.String propName)` Returns the value of a property as a generic object.
`java.lang.String` | `getSelectionValueListMethod()` Gets the method content of `getSelectionValueList`.
`java.lang.String` | `getType()` Deprecated. Replaced by the method `AbstractScalarParameterHandle.getDataType()`
`java.lang.String` | `getValueColumn()` Deprecated. Replaced by the method `AbstractScalarParameterHandle.getValueExpr()`
`boolean` | `isConcealValue()` Tests whether hides the user's entry by displaying asterisks.
`boolean` | `isFixedOrder()` Tests whether to display values in the order defined in the list.
`boolean` | `isMustMatch()` Tests whether the value must match one of values in the selection list.
`void` | `removedUnusedColumnBindings()` Removed unused bound columns from the parameter.
`void` | `setAlignment(java.lang.String align)` Sets the alignment for this parameter.
`void` | `setAllowBlank(boolean allowBlank)` Deprecated. by `AbstractScalarParameterHandle.setIsRequired(boolean)`
`void` | `setAllowNull(boolean allowNull)` Deprecated. by `AbstractScalarParameterHandle.setIsRequired(boolean)`
`void` | `setAutoSuggestThreshold(int number)` Sets the maximal number of of entries a report parameter pick list can have.
`void` | `setCategory(java.lang.String category)` Sets the category for the parameter format.
`void` | `setConcealValue(boolean concealValue)` Sets the attribute that's hides the user's entry by displaying asterisks.
`void` | `setControlType(java.lang.String controlType)` Sets the control type for this parameter.
`void` | `setDefaultValue(java.lang.String defaultValue)` Deprecated. since 2.5 replaced by `AbstractScalarParameterHandle.setDefaultValueList(List)`
`void` | `setDefaultValueListMethod(java.lang.String getDefaultValueListMethod)` Sets the method content of `getDefaultValueList`.
`void` | `setFixedOrder(boolean fixedOrder)` Sets the flag indicates that whether to display values in the order defined in the list.
`void` | `setFormat(java.lang.String format)` Deprecated. replaced by setPattern and setCategory.
`void` | `setLabelColumn(java.lang.String labelColumn)` Deprecated. Replaced by the method `AbstractScalarParameterHandle.setLabelExpr(String)`
`void` | `setMustMatch(boolean mustMatch)` Sets the flag indicates that whether the value must match one of values in the selection list.
`void` | `setParamType(java.lang.String type)` Sets the parameter type for this scalar parameter.
`void` | `setPattern(java.lang.String pattern)` Sets the pattern of format instructions for the parameter value.
`void` | `setProperty(java.lang.String propName, java.lang.Object value)` Sets the value of a property from a generic object.
`void` | `setSelectionValueListMethod(java.lang.String getSelectionValueListMethod)` Sets the method content of `getSelectionValueList`.
`void` | `setType(java.lang.String type)` Deprecated. Replaced by the method `AbstractScalarParameterHandle.setDataType(String)`
`void` | `setValueColumn(java.lang.String valueColumn)` Deprecated. Replaced by the method `AbstractScalarParameterHandle.setValueExpr(String)`

Methods inherited from class org.eclipse.birt.report.model.api.AbstractScalarParameterHandle
`choiceIterator, distinct, getDataSet, getDataSetName, getDataType, getDefaultValueList, getLabelExpr, getSortBy, getSortByColumn, getSortDirection, getValueExpr, getValueType, isRequired, setDataSetName, setDataType, setDefaultValueList, setDistinct, setIsRequired, setLabelExpr, setListlimit, setSortBy, setSortByColumn, setSortDirection, setValueExpr, setValueType`

Methods inherited from class org.eclipse.birt.report.model.api.ParameterHandle
`getDisplayPromptText, getHelpText, getHelpTextKey, getPromptText, getPromptTextID, getValidate, isHidden, setHelpText, setHelpTextKey, setHidden, setPromptText, setPromptTextID, setValidate`

Methods inherited from class org.eclipse.birt.report.model.api.ReportElementHandle
`getComments, getCustomXml, getDisplayName, getDisplayNameKey, getElement, getPropertyMask, isValidLayoutForCompoundElement, isValidReferenceForCompoundElement, propertyMaskIterator, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setPropertyMask`

Methods inherited from class org.eclipse.birt.report.model.api.DesignElementHandle
`add, add, addElement, addElement, addListener, addUserPropertyDefn, cachePropertyHandles, canContain, canContain, canContain, canContain, canDrop, canEdit, canTransformToTemplate, clearAllProperties, clearContents, clearProperty, clientsIterator, copy, copyPropertyTo, createTemplateElement, derivedIterator, doSort, drop, drop, drop, dropAndClear, dropAndClear, dropAndClear, dropUserPropertyDefn, findContentSlot, getBooleanProperty, getChoices, getColorProperty, getContainer, getContainerPropertyHandle, getContainerSlotHandle, getContent, getContentCount, getContents, getDefn, getDesign, getDesignHandle, getDimensionProperty, getDisplayLabel, getDisplayLabel, getDisplayProperty, getEffectiveModule, getElementFactory, getElementProperty, getEventHandlerClass, getExpressionProperty, getExtends, getExternalizedValue, getExternalizedValue, getExternalizedValue, getFactoryElementHandle, getFactoryPropertyHandle, getFloatProperty, getFontProperty, getFullName, getHostViewHandle, getID, getIndex, getIntProperty, getListProperty, getListProperty, getMethods, getModule, getModuleHandle, getName, getNumberProperty, getPrivateStyle, getPropertyBinding, getPropertyBindingExpression, getPropertyBindings, getPropertyDefn, getPropertyHandle, getPropertyIterator, getQualifiedName, getRoot, getSemanticErrors, getSlot, getStringProperty, getStyle, getUserProperties, getUserPropertyDefnHandle, getXPath, hasLocalProperties, hasSemanticError, initializeSlotHandles, isDirectionRTL, isInTemplateParameter, isTemplateParameterValue, isValid, localize, move, move, moveTo, moveTo, moveTo, moveTo, newHandlerOnEachEvent, paste, paste, paste, paste, removeListener, revertToReportItem, revertToTemplate, semanticCheck, setBooleanProperty, setEncryption, setEventHandlerClass, setExpressionProperty, setExtends, setExtendsElement, setExtendsName, setFloatProperty, setIntProperty, setName, setNewHandlerOnEachEvent, setNumberProperty, setProperties, setPropertyBinding, setPropertyBinding, setStringProperty, setStyle, setStyleElement, setStyleName, setValid, shift, showError, slotsIterator`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### ScalarParameterHandle

    public ScalarParameterHandle(org.eclipse.birt.report.model.core.Module module,
                                 org.eclipse.birt.report.model.core.DesignElement element)

  Constructs a handle for the ScalarParamter with the given design and the parameter. The application generally does not create handles directly. Instead, it uses one of the navigation methods available on other element handles.

  Parameters:
    `module` - the module
    `element` - the model representation of the element

Method Detail

### getDefaultValue

    public java.lang.String getDefaultValue()

  Deprecated. since 2.5 replaced by `AbstractScalarParameterHandle.getDefaultValueList()`

  Returns the first default value of the parameter. The default value can be an expression, but cannot reference any other parameters. The default value of this parameter can be a list. This method returns the first value if exists.

  Returns:
    the default value

### setDefaultValue

    public void setDefaultValue(java.lang.String defaultValue)
                         throws SemanticException

  Deprecated. since 2.5 replaced by `AbstractScalarParameterHandle.setDefaultValueList(List)`

  Sets the default value of the parameter. The default value can be an expression, but cannot reference any other parameters.

  Parameters:
    `defaultValue` - the default value for the parameter
  Throws:
    `SemanticException` - if the property is locked.

### isConcealValue

    public boolean isConcealValue()

  Tests whether hides the user's entry by displaying asterisks. Often used for passwords.

  Returns:
    `true` if hides the user's entry by asterisks, `false` if shows characters as usual.

### setConcealValue

    public void setConcealValue(boolean concealValue)
                         throws SemanticException

  Sets the attribute that's hides the user's entry by displaying asterisks. Often used for passwords.

  Parameters:
    `concealValue` - `true` if hides the user's entry by asterisks, `false` if shows characters as usual.
  Throws:
    `SemanticException` - if the property is locked.

### allowNull

    public boolean allowNull()

  Deprecated. by `AbstractScalarParameterHandle.isRequired()`

  Tests whether the value of the parameter can be `null`.

  Returns:
    `true` if the value can be `null`, `false` if the value can not be `null`.

### setAllowNull

    public void setAllowNull(boolean allowNull)
                      throws SemanticException

  Deprecated. by `AbstractScalarParameterHandle.setIsRequired(boolean)`

  Sets the flag that indicates whether the value of the parameter can be `null`.

  Parameters:
    `allowNull` - `true` if the value can be `null`, `false` if the value can not be `null`.
  Throws:
    `SemanticException` - if the property is locked.

### allowBlank

    public boolean allowBlank()

  Deprecated. by `AbstractScalarParameterHandle.isRequired()`

  Tests whether the string value of the parameter can be `null`.

  Returns:
    `true` if the value can be `null`, `false` if the value can not be `null`.

### setAllowBlank

    public void setAllowBlank(boolean allowBlank)
                       throws SemanticException

  Deprecated. by `AbstractScalarParameterHandle.setIsRequired(boolean)`

  Sets the flag that indicates whether the string value of the parameter can be `null`.

  Parameters:
    `allowBlank` - `true` if the value can be `null`, `false` if the value can not be `null`.
  Throws:
    `SemanticException` - if the property is locked.

### getFormat

    public java.lang.String getFormat()

  Deprecated. replaced by getPattern and getCategory.

  Returns the format instructions for the parameter value. The format is used by the UI to display the value.

  Returns:
    the format for the parameter value

### getPattern

    public java.lang.String getPattern()

  Returns the pattern of format instructions for the parameter value. The format is used by the UI to display the value.

  Returns:
    the pattern of format for the parameter value

### getCategory

    public java.lang.String getCategory()

  Returns the category for the parameter format. The format is used by the UI to display the value.

  Returns:
    the category for the parameter format

### setFormat

    public void setFormat(java.lang.String format)
                   throws SemanticException

  Deprecated. replaced by setPattern and setCategory.

  Sets the format instructions for the parameter value. The format is used by the UI to display the value.

  Parameters:
    `format` - the format for the parameter value
  Throws:
    `SemanticException` - if the property is locked.

### setPattern

    public void setPattern(java.lang.String pattern)
                    throws SemanticException

  Sets the pattern of format instructions for the parameter value. The format is used by the UI to display the value.

  Parameters:
    `pattern` - the format for the parameter value
  Throws:
    `SemanticException` - if the property is locked.

### setCategory

    public void setCategory(java.lang.String category)
                     throws SemanticException

  Sets the category for the parameter format. The format is used by the UI to display the value.

  Parameters:
    `category` - the category for the format
  Throws:
    `SemanticException` - if the property is locked.

### getControlType

    public java.lang.String getControlType()

  Returns the control type for this parameter. Control types are one of constants defined in `DesignChoiceConstants`:
  - PARAM_CONTROL_TEXT_BOX
  - PARAM_CONTROL_LIST_BOX
  - PARAM_CONTROL_COMBOBOX
  - PARAM_CONTROL_RADIO_BUTTON
  - PARAM_CONTROL_CHECK_BOX
  - PARAM_CONTROL_AUTO_SUGGEST

  Returns:
    the control type for the UI to display the parameter
  See Also:
    `DesignChoiceConstants`

### getListlimit

    public int getListlimit()

  get the list limited number.

  Overrides:
    `getListlimit` in class `AbstractScalarParameterHandle`
  Returns:
    the display prompt.

### setControlType

    public void setControlType(java.lang.String controlType)
                        throws SemanticException

  Sets the control type for this parameter. Control types are one of constants defined in `DesignChoiceConstants`:
  - PARAM_CONTROL_TEXT_BOX
  - PARAM_CONTROL_LIST_BOX
  - PARAM_CONTROL_COMBOBOX
  - PARAM_CONTROL_RADIO_BUTTON
  - PARAM_CONTROL_CHECK_BOX
  - PARAM_CONTROL_AUTO_SUGGEST

  Parameters:
    `controlType` - the control type for the UI to display the parameter
  Throws:
    `SemanticException` - if the input type is not one of above choices.
  See Also:
    `AbstractScalarParameterHandle.getDataType()`, `DesignChoiceConstants`

### getAlignment

    public java.lang.String getAlignment()

  Returns the alignment for this parameter. Alignments can be one of the constants defined in `DesignChoiceConstants`:
  - `SCALAR_PARAM_ALIGN_AUTO`
  - `SCALAR_PARAM_ALIGN_LEFT`
  - `SCALAR_PARAM_ALIGN_CENTER`
  - `SCALAR_PARAM_ALIGN_RIGHT`

  Returns:
    the alignment for the UI to display the parameter
  See Also:
    `DesignChoiceConstants`

### setAlignment

    public void setAlignment(java.lang.String align)
                      throws SemanticException

  Sets the alignment for this parameter. Alignments can be one of the constants defined in `DesignChoiceConstants`:
  - `SCALAR_PARAM_ALIGN_AUTO`
  - `SCALAR_PARAM_ALIGN_LEFT`
  - `SCALAR_PARAM_ALIGN_CENTER`
  - `SCALAR_PARAM_ALIGN_RIGHT`

  Parameters:
    `align` - the alignment for the UI to display the parameter
  Throws:
    `SemanticException` - if the input type is not one of above choices.
  See Also:
    `DesignChoiceConstants`

### isMustMatch

    public boolean isMustMatch()

  Tests whether the value must match one of values in the selection list.

  Returns:
    `true` if the value must match one of values in the list, otherwise `false`.

### setMustMatch

    public void setMustMatch(boolean mustMatch)
                      throws SemanticException

  Sets the flag indicates that whether the value must match one of values in the selection list.

  Parameters:
    `mustMatch` - `true` if the value must match one of values in the list, otherwise `false`.
  Throws:
    `SemanticException` - if the property is locked.

### isFixedOrder

    public boolean isFixedOrder()

  Tests whether to display values in the order defined in the list.

  Returns:
    `true` if to display value in the order, otherwise `false`.

### setFixedOrder

    public void setFixedOrder(boolean fixedOrder)
                       throws SemanticException

  Sets the flag indicates that whether to display values in the order defined in the list.

  Parameters:
    `fixedOrder` - `true` if to display values in the order, otherwise `false`.
  Throws:
    `SemanticException` - if the property is locked.

### getValueColumn

    public java.lang.String getValueColumn()

  Deprecated. Replaced by the method `AbstractScalarParameterHandle.getValueExpr()`

  Returns the name of the query column that returns values for the choice of the dynamic list for this parameter.

  Returns:
    the the name of the query column

### setValueColumn

    public void setValueColumn(java.lang.String valueColumn)
                        throws SemanticException

  Deprecated. Replaced by the method `AbstractScalarParameterHandle.setValueExpr(String)`

  Sets the name of the query column that returns values for the choice of the dynamic list for this parameter.

  Parameters:
    `valueColumn` - the name of the query column
  Throws:
    `SemanticException` - if the property is locked.

### getLabelColumn

    public java.lang.String getLabelColumn()

  Deprecated. Replaced by the method `AbstractScalarParameterHandle.getLabelExpr()`

  Returns the name of the query column that returns the prompt for the choice of the dynamic list for this parameter.

  Returns:
    the the name of the query column

### setLabelColumn

    public void setLabelColumn(java.lang.String labelColumn)
                        throws SemanticException

  Deprecated. Replaced by the method `AbstractScalarParameterHandle.setLabelExpr(String)`

  Sets the name of the query column that returns the prompt for the choice of the dynamic list for this parameter.

  Parameters:
    `labelColumn` - the name of the query column
  Throws:
    `SemanticException` - if the property is locked.

### getType

    public java.lang.String getType()

  Deprecated. Replaced by the method `AbstractScalarParameterHandle.getDataType()`

  Returns the data type for this parameter. The data type controls how the requester formats, parses and validates the parameter. Types are defined in `DesignChoiceConstants` can be one of the followings:
  - `PARAM_TYPE_STRING`
  - `PARAM_TYPE_FLOAT`
  - `PARAM_TYPE_DECIMAL`
  - `PARAM_TYPE_INTEGER`
  - `PARAM_TYPE_DATETIME`
  - `PARAM_TYPE_DATE`
  - `PARAM_TYPE_TIME`
  - `PARAM_TYPE_BOOLEAN`

  Returns:
    the type for the parameter
  See Also:
    `setType(String)`, `DesignChoiceConstants`

### setType

    public void setType(java.lang.String type)
                 throws SemanticException

  Deprecated. Replaced by the method `AbstractScalarParameterHandle.setDataType(String)`

  Sets the data type for this parameter. The data type controls how the Requester formats, parses and validates the parameter. Types are defined in `DesignChoiceConstants` can be one of the followings:
  - `PARAM_TYPE_STRING`
  - `PARAM_TYPE_FLOAT`
  - `PARAM_TYPE_DECIMAL`
  - `PARAM_TYPE_INTEGER`
  - `PARAM_TYPE_DATETIME`
  - `PARAM_TYPE_DATE`
  - `PARAM_TYPE_TIME`
  - `PARAM_TYPE_BOOLEAN`

  Parameters:
    `type` - the type for the parameter
  Throws:
    `SemanticException` - if the input type is not one of above choices.
  See Also:
    `getType()`, `DesignChoiceConstants`

### columnBindingsIterator

    public java.util.Iterator columnBindingsIterator()

  Returns the bound columns that binds the data set columns. The item in the iterator is the corresponding `ComputedColumnHandle`.

  Returns:
    a list containing the bound columns.

### getColumnBindings

    public PropertyHandle getColumnBindings()

  Get a handle to deal with the bound column.

  Returns:
    a handle to deal with the bound data column.

### addColumnBinding

    public ComputedColumnHandle addColumnBinding(ComputedColumn addColumn,
                                                 boolean inForce)
                                          throws SemanticException

  Adds a bound column to the list.

  Parameters:
    `addColumn` - the bound column to add
    `inForce` - `true` the column is added to the list regardless of duplicate expression. `false` do not add the column if the expression already exist
    `column` - the bound column
  Returns:
    the newly created `ComputedColumnHandle` or the existed `ComputedColumnHandle` in the list
  Throws:
    `SemanticException` - if expression is not duplicate but the name duplicates the existing bound column. Or, if the both name/expression are duplicate, but `inForce` is `true`.

### removedUnusedColumnBindings

    public void removedUnusedColumnBindings()
                                     throws SemanticException

  Removed unused bound columns from the parameter. Bound columns of nested elements will not be removed.

  Throws:
    `SemanticException` - if bound column property is locked.

### setProperty

    public void setProperty(java.lang.String propName,
                            java.lang.Object value)
                     throws SemanticException

  Description copied from class: `DesignElementHandle`
  Sets the value of a property from a generic object. The value can be any of the supported types: String, Double, Integer, BigDecimal or one of the specialized property types. The type of object allowed depends on the type of the property.

  Overrides:
    `setProperty` in class `DesignElementHandle`
  Parameters:
    `propName` - the property name
    `value` - the value to set
  Throws:
    `SemanticException` - if the property is undefined on the element or the value is invalid.

### getProperty

    public java.lang.Object getProperty(java.lang.String propName)

  Description copied from class: `DesignElementHandle`
  Returns the value of a property as a generic object. The value is the internal property value, it is not localized. For a property with the element reference type, the reference element name is returned.

  Overrides:
    `getProperty` in class `DesignElementHandle`
  Parameters:
    `propName` - the name of the property of interest
  Returns:
    the value of the property. The type of the returned object depends on the property type.
  See Also:
    `DesignElementHandle.getIntProperty(java.lang.String)`, `DesignElementHandle.getStringProperty(java.lang.String)`, `DesignElementHandle.getFloatProperty(java.lang.String)`, `DesignElementHandle.getNumberProperty(java.lang.String)`

### getParamType

    public java.lang.String getParamType()

  Returns the parameter type for this scalar parameter. Types are defined in `DesignChoiceConstants` can be one of the followings:
  - `SCALAR_PARAM_TYPE_SIMPLE`
  - `SCALAR_PARAM_TYPE_MULTI_VALUE`
  - `SCALAR_PARAM_TYPE_AD_HOC`

  Returns:
    the type for the parameter
  See Also:
    `setParamType(String)`, `DesignChoiceConstants`

### setParamType

    public void setParamType(java.lang.String type)
                      throws SemanticException

  Sets the parameter type for this scalar parameter. Types are defined in `DesignChoiceConstants` can be one of the followings:
  - `SCALAR_PARAM_TYPE_SIMPLE`
  - `SCALAR_PARAM_TYPE_MULTI_VALUE`
  - `SCALAR_PARAM_TYPE_AD_HOC`

  Parameters:
    `type` - the type for the parameter
  Throws:
    `SemanticException` - if the input type is not one of above choices.
  See Also:
    `getParamType()`, `DesignChoiceConstants`

### getAutoSuggestThreshold

    public int getAutoSuggestThreshold()

  Returns the maximal number of of entries a report parameter pick list can have.

  Returns:
    the threshold number.

### setAutoSuggestThreshold

    public void setAutoSuggestThreshold(int number)
                                 throws SemanticException

  Sets the maximal number of of entries a report parameter pick list can have.

  Parameters:
    `number` - the threshold number.
  Throws:
    `SemanticException`

### getDefaultValueListMethod

    public java.lang.String getDefaultValueListMethod()

  Gets the method content of `getDefaultValueList`.

  Returns:
    the method content of `getDefaultValueList`

### setDefaultValueListMethod

    public void setDefaultValueListMethod(java.lang.String getDefaultValueListMethod)
                                   throws SemanticException

  Sets the method content of `getDefaultValueList`.

  Parameters:
    `getDefaultValueListMethod` - the method content of `getDefaultValueList` to set
  Throws:
    `SemanticException`

### getSelectionValueListMethod

    public java.lang.String getSelectionValueListMethod()

  Gets the method content of `getSelectionValueList`.

  Returns:
    the method content of `getSelectionValueList`

### setSelectionValueListMethod

    public void setSelectionValueListMethod(java.lang.String getSelectionValueListMethod)
                                     throws SemanticException

  Sets the method content of `getSelectionValueList`.

  Parameters:
    `getSelectionValueListMethod` - the method content of `getSelectionValueList` to set
  Throws:
    `SemanticException`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008 Actuate Corp. All rights reserved.