Class TaskOption
java.lang.Object
org.eclipse.birt.report.engine.api.TaskOption
- All Implemented Interfaces:
ITaskOption
- Direct Known Subclasses:
DataExtractionOption
,RenderOption
Define the class of task options
- Since:
- 3.3
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
getBooleanOption
(String name, boolean defaultValue) Get boolean option value by name.int
getIntOption
(String name, int defaultValue) Get the options int basedget option value for one rendering optionGet options.getStringOption
(String name) Get option value by name.boolean
Check if an option is defined.void
set value for one rendering option
-
Field Details
-
options
a hash map that stores the rendering options
-
-
Constructor Details
-
TaskOption
public TaskOption()constructor -
TaskOption
Constructor.- Parameters:
options
-
-
-
Method Details
-
setOption
set value for one rendering option- Specified by:
setOption
in interfaceITaskOption
- Parameters:
name
- the option namevalue
- value for the option
-
getOption
get option value for one rendering option- Specified by:
getOption
in interfaceITaskOption
- Parameters:
name
- the option name- Returns:
- the option value
-
hasOption
Check if an option is defined.- Specified by:
hasOption
in interfaceITaskOption
- Parameters:
name
- option name.- Returns:
- true if user has defined an option with this name, even if the value is NULL. false otherwise.
-
getOptions
Get options.- Specified by:
getOptions
in interfaceITaskOption
- Returns:
- options
-
getStringOption
Get option value by name.- Parameters:
name
- the option name- Returns:
- the option value
-
getBooleanOption
Get boolean option value by name.- Parameters:
name
- the option namedefaultValue
- default option value- Returns:
- default value
-
getIntOption
Get the options int based- Parameters:
name
-defaultValue
-- Returns:
- Return the options int based
-