|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
defines common features for an engine task. A task captures a set of operations that engine performs to get a unit of work done.
Method Summary | |
void |
addScriptableJavaObject(java.lang.String jsName,
java.lang.Object obj)
defines an additional Java object that is exposed to BIRT scripting at a per-task level |
void |
close()
close the task, relese any resources. |
java.util.Map |
getAppContext()
returns the context objects for the task |
ReportEngine |
getEngine()
returns the report engine object |
int |
getID()
returns an identifier for the task. |
java.util.Locale |
getLocale()
returns the locale for running the task |
java.lang.Object |
getParameterValue(java.lang.String name)
returns the value of a parameter. |
java.util.HashMap |
getParameterValues()
returns the parameter name/value collection |
IReportRunnable |
getReportRunnable()
returns the runnable report design object |
void |
setAppContext(java.util.Map context)
sets the task context |
void |
setLocale(java.util.Locale locale)
sets the task locale |
void |
setParameterValue(java.lang.String name,
java.lang.Object value)
sets one parameter value |
void |
setParameterValues(java.util.Map params)
set all parameter valuess |
boolean |
validateParameters()
|
Method Detail |
public void setLocale(java.util.Locale locale)
locale
- the task localepublic void setAppContext(java.util.Map context)
context
- - task contexts in a map. The map contains name-value pairspublic java.util.Locale getLocale()
public java.util.Map getAppContext()
public ReportEngine getEngine()
public void addScriptableJavaObject(java.lang.String jsName, java.lang.Object obj)
jsName
- the name that the object is referenced in JavaScriptobj
- the Java object that is wrapped and scriptedpublic int getID()
public IReportRunnable getReportRunnable()
public void setParameterValues(java.util.Map params)
params
- a hash map with all parameterspublic void setParameterValue(java.lang.String name, java.lang.Object value)
name
- parameter namevalue
- parameter valuepublic java.util.HashMap getParameterValues()
public java.lang.Object getParameterValue(java.lang.String name)
public boolean validateParameters()
public void close()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |