|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IGetParameterDefinitionTask
an engine task that retrieves parameter definitions from a report. The task retrieves parameter definitions, default values and dynamic selection lists.
Field Summary |
---|
Fields inherited from interface org.eclipse.birt.report.engine.api.IEngineTask |
---|
CANCEL_ON_ERROR, CONTINUE_ON_ERROR, STATUS_CANCELLED, STATUS_FAILED, STATUS_NOT_STARTED, STATUS_RUNNING, STATUS_SUCCEEDED, TASK_DATAEXTRACTION, TASK_GETPARAMETERDEFINITION, TASK_RENDER, TASK_RUN, TASK_RUNANDRENDER, TASK_UNKNOWN |
Method Summary | |
---|---|
void |
evaluateDefaults()
Deprecated. use getDefaultParameterValues() directly. |
void |
evaluateQuery(java.lang.String parameterGroupName)
Deprecated. This api has no use. |
java.lang.Object |
getDefaultValue(IParameterDefnBase param)
get default value by parameter name |
java.lang.Object |
getDefaultValue(java.lang.String name)
get the default value of parameter. |
java.util.HashMap |
getDefaultValues()
get all default values |
org.eclipse.birt.report.model.api.ParameterHandle |
getParameter(java.lang.String name)
Deprecated. |
IParameterDefnBase |
getParameterDefn(java.lang.String name)
returns the parameter definition given the parameter name name |
java.util.Collection |
getParameterDefns(boolean includeParameterGroups)
return report parameter definitions |
org.eclipse.birt.report.model.api.SlotHandle |
getParameters()
Deprecated. |
java.util.Collection |
getSelectionList(java.lang.String name)
get the collections of a selection choices. |
java.util.Collection |
getSelectionListForCascadingGroup(java.lang.String parameterGroupName,
java.lang.Object[] groupKeyValues)
The second step to work with the cascading parameters. |
java.util.Collection |
getSelectionTreeForCascadingGroup(java.lang.String parameterGroupName)
Gets selection tree for a cascading parameter group. |
void |
setValue(java.lang.String name,
java.lang.Object value)
Set one parameter value. |
Methods inherited from interface org.eclipse.birt.report.engine.api.IEngineTask |
---|
addScriptableJavaObject, cancel, cancel, close, getAppContext, getCancelFlag, getEngine, getErrors, getID, getLocale, getLogger, getParameterDisplayText, getParameterValue, getParameterValues, getReportRunnable, getStatus, getTaskType, getULocale, setAppContext, setDataSource, setDataSource, setErrorHandlingOption, setLocale, setLocale, setLogger, setParameter, setParameterDisplayText, setParameterValue, setParameterValues, setTimeZone, setUserACL, validateParameters |
Method Detail |
---|
java.util.Collection getParameterDefns(boolean includeParameterGroups)
includeParameterGroups
- whether returns one level of parameters with parameter groups
or return a flatten collection of all parameters
IParameterDefnBase getParameterDefn(java.lang.String name)
name
- the parameter name
void evaluateDefaults() throws EngineException
EngineException
- throws exception when there is an error evaluating default value expressionsvoid setValue(java.lang.String name, java.lang.Object value)
name
- the parametervalue
- the value of the parameterjava.util.HashMap getDefaultValues()
java.lang.Object getDefaultValue(IParameterDefnBase param)
param
- reference to a parameter
java.lang.Object getDefaultValue(java.lang.String name)
name
- parameter name
org.eclipse.birt.report.model.api.ParameterHandle getParameter(java.lang.String name)
name
- parameter name
org.eclipse.birt.report.model.api.SlotHandle getParameters()
java.util.Collection getSelectionList(java.lang.String name)
name
- parameter name
void evaluateQuery(java.lang.String parameterGroupName)
parameterGroupName
- - the cascading parameter group namejava.util.Collection getSelectionListForCascadingGroup(java.lang.String parameterGroupName, java.lang.Object[] groupKeyValues)
parameterGroupName
- - the cascading parameter group namegroupKeyValues
- - the array of known parameter values (see the example above)
java.util.Collection getSelectionTreeForCascadingGroup(java.lang.String parameterGroupName)
parameterGroupName
- name of the cascading parameter group.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |