org.eclipse.birt.report.engine.api
Interface IScalarParameterDefn

All Superinterfaces:
IParameterDefn, IParameterDefnBase

public interface IScalarParameterDefn
extends IParameterDefn

Defines a scalar parameter


Field Summary
static int AUTO
           
static int CENTER
           
static int CHECK_BOX
           
static int LEFT
           
static int LIST_BOX
           
static int RADIO_BUTTON
           
static int RIGHT
           
static int SELECTION_LIST_DYNAMIC
           
static int SELECTION_LIST_NONE
           
static int SELECTION_LIST_STATIC
           
static java.lang.String SELECTION_LIST_TYPE_DYNAMIC
           
static java.lang.String SELECTION_LIST_TYPE_STATIC
           
static int TEXT_BOX
           
static int TYPE_ANY
           
static int TYPE_BOOLEAN
           
static int TYPE_DATE
           
static int TYPE_DATE_TIME
           
static int TYPE_DECIMAL
           
static int TYPE_FLOAT
           
static int TYPE_INTEGER
           
static int TYPE_STRING
           
static int TYPE_TIME
           
 
Fields inherited from interface org.eclipse.birt.report.engine.api.IParameterDefnBase
CASCADING_PARAMETER_GROUP, FILTER_PARAMETER, LIST_PARAMETER, PARAMETER_GROUP, SCALAR_PARAMETER, TABLE_PARAMETER
 
Method Summary
 boolean allowBlank()
          Deprecated.  
 boolean allowNewValues()
          returns whether the user can enter a value different from values in a selection list Applies only to parameters with a selection list.
 boolean allowNull()
          Deprecated.  
 boolean displayInFixedOrder()
          returns whether the UI should display the seleciton list in a fixed order.
 int getAlignment()
           
 int getControlType()
           
 int getDataType()
          returns the parameter data type.
 java.lang.String getDefaultValue()
           
 java.lang.String getDisplayFormat()
           
 java.util.ArrayList getSelectionList()
          Deprecated.  
 int getSelectionListType()
           
 boolean isRequired()
           
 boolean isValueConcealed()
           
 
Methods inherited from interface org.eclipse.birt.report.engine.api.IParameterDefn
isHidden
 
Methods inherited from interface org.eclipse.birt.report.engine.api.IParameterDefnBase
getDisplayName, getHandle, getHelpText, getName, getParameterType, getPromptText, getTypeName, getUserPropertyValue, getUserPropertyValues
 

Field Detail

TEXT_BOX

public static final int TEXT_BOX
See Also:
Constant Field Values

LIST_BOX

public static final int LIST_BOX
See Also:
Constant Field Values

RADIO_BUTTON

public static final int RADIO_BUTTON
See Also:
Constant Field Values

CHECK_BOX

public static final int CHECK_BOX
See Also:
Constant Field Values

AUTO

public static final int AUTO
See Also:
Constant Field Values

LEFT

public static final int LEFT
See Also:
Constant Field Values

CENTER

public static final int CENTER
See Also:
Constant Field Values

RIGHT

public static final int RIGHT
See Also:
Constant Field Values

TYPE_ANY

public static final int TYPE_ANY
See Also:
Constant Field Values

TYPE_STRING

public static final int TYPE_STRING
See Also:
Constant Field Values

TYPE_FLOAT

public static final int TYPE_FLOAT
See Also:
Constant Field Values

TYPE_DECIMAL

public static final int TYPE_DECIMAL
See Also:
Constant Field Values

TYPE_DATE_TIME

public static final int TYPE_DATE_TIME
See Also:
Constant Field Values

TYPE_BOOLEAN

public static final int TYPE_BOOLEAN
See Also:
Constant Field Values

TYPE_INTEGER

public static final int TYPE_INTEGER
See Also:
Constant Field Values

TYPE_DATE

public static final int TYPE_DATE
See Also:
Constant Field Values

TYPE_TIME

public static final int TYPE_TIME
See Also:
Constant Field Values

SELECTION_LIST_NONE

public static final int SELECTION_LIST_NONE
See Also:
Constant Field Values

SELECTION_LIST_DYNAMIC

public static final int SELECTION_LIST_DYNAMIC
See Also:
Constant Field Values

SELECTION_LIST_STATIC

public static final int SELECTION_LIST_STATIC
See Also:
Constant Field Values

SELECTION_LIST_TYPE_STATIC

public static final java.lang.String SELECTION_LIST_TYPE_STATIC
See Also:
Constant Field Values

SELECTION_LIST_TYPE_DYNAMIC

public static final java.lang.String SELECTION_LIST_TYPE_DYNAMIC
See Also:
Constant Field Values
Method Detail

getDataType

public int getDataType()
returns the parameter data type. See the ColumnDefn class for the valid data type constants.

Returns:
the parameter data type

allowNewValues

public boolean allowNewValues()
returns whether the user can enter a value different from values in a selection list Applies only to parameters with a selection list. Usually, a parameter with allowNewValue=true is displayed as a combo-box, while a parameter with allowNewValue=false is displayed as a list. This is only a UI gesture. Engine does not validate whether the value passed in is in the list.

Returns:
whether the user can enter a value different from all values in the list. Applies only when the parameter has a selection list. Default is true.

displayInFixedOrder

public boolean displayInFixedOrder()
returns whether the UI should display the seleciton list in a fixed order. Only applies to parameters with a selection list.

Returns:
whether the UI should display the selection list in fixed order as the values appear in the list. Default is true.

isValueConcealed

public boolean isValueConcealed()
Returns:
whether the input value needs to be concealed (i.e., password, bank account number, etc.)

allowNull

public boolean allowNull()
Deprecated.  

Returns:
whether the parameter allow null value. If it does not, the end user has to supply a value for the parameter before the report can be run

allowBlank

public boolean allowBlank()
Deprecated.  

Returns:
whether the parameter allow empty string as input. If not, the end user has to supply a string value that is non-empty

isRequired

public boolean isRequired()
Returns:
whether the parameter is required.
the rule for String type is:
  • isRequired=true, allowNull and allowBlank are false
  • isRequired=false, allowNull and allowBlank are true

  • for other type like integer:
  • isRequired=true, allowNull and allowBlank are false
  • isRequired=false, allowNull and allowBlank are true

  • getDisplayFormat

    public java.lang.String getDisplayFormat()
    Returns:
    the formatting instructions for the parameter value within the parameter UI

    getControlType

    public int getControlType()
    Returns:
    the control type used in the parameter UI. Supports TEXT_BOX (default), LIST_BOX, RADIO_BUTTON and CHECK_BOX.

    getAlignment

    public int getAlignment()
    Returns:
    how the items should appear in the UI. Choices are AUTO (default), LEFT, CENTER and RIGHT

    getSelectionList

    public java.util.ArrayList getSelectionList()
    Deprecated.  

    Returns:
    get a parameter value selection object, from which a list of parameter values and label values can be retrieved.

    getSelectionListType

    public int getSelectionListType()
    Returns:
    the type of the parameter selection list

    getDefaultValue

    public java.lang.String getDefaultValue()
    Returns:
    the default value


    Copyright © 2005 Actuate Corp. All rights reserved.