|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IEngineTask
defines common features for an engine task. A task captures a set of operations that engine performs to get a unit of work done.
Field Summary | |
---|---|
static int |
CANCEL_ON_ERROR
cancel the task execution if there is an error. |
static int |
CONTINUE_ON_ERROR
continue the task execution if there is an error. |
static int |
STATUS_CANCELLED
the task is finished by cancled |
static int |
STATUS_FAILED
the task is finished with errors |
static int |
STATUS_NOT_STARTED
the task is not running yet |
static int |
STATUS_RUNNING
the task is running |
static int |
STATUS_SUCCEEDED
the task is finished with sucessful |
static int |
TASK_DATAEXTRACTION
|
static int |
TASK_GETPARAMETERDEFINITION
|
static int |
TASK_RENDER
|
static int |
TASK_RUN
|
static int |
TASK_RUNANDRENDER
|
static int |
TASK_UNKNOWN
|
Method Summary | |
---|---|
void |
addScriptableJavaObject(java.lang.String jsName,
java.lang.Object obj)
Deprecated. user should add it to appContext. |
void |
cancel()
set the cancel flag if the task is running. |
void |
cancel(java.lang.Object signal)
Deprecated. user should use cancel() instead. |
void |
close()
close the task, relese any resources. |
java.util.Map |
getAppContext()
returns the context objects for the task. |
boolean |
getCancelFlag()
return a flag if the user called cancel. |
IReportEngine |
getEngine()
returns the report engine object |
java.util.List |
getErrors()
Gets all exceptions that are thrown out during executing this task. |
int |
getID()
returns an identifier for the task. |
java.util.Locale |
getLocale()
returns the locale for running the task |
java.util.logging.Logger |
getLogger()
return the logger used by the task. |
java.lang.String |
getParameterDisplayText(java.lang.String name)
Gets parameter display text by parameter name. |
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 |
int |
getStatus()
get the status of task |
int |
getTaskType()
Gets the type of the engine. |
com.ibm.icu.util.ULocale |
getULocale()
returns the locale for running the task |
void |
setAppContext(java.util.Map context)
sets the task context. |
void |
setDataSource(org.eclipse.birt.core.archive.IDocArchiveReader dataSource)
set the data source used by the engine task. |
void |
setDataSource(org.eclipse.birt.core.archive.IDocArchiveReader dataSource,
java.lang.String reportlet)
set the data source used by the engine task. |
void |
setErrorHandlingOption(int option)
set the error handling mode for the first error. |
void |
setLocale(java.util.Locale locale)
sets the task locale |
void |
setLocale(com.ibm.icu.util.ULocale locale)
sets the task locale |
void |
setLogger(java.util.logging.Logger logger)
set the logger used by the task. |
void |
setParameter(java.lang.String name,
java.lang.Object value,
java.lang.String displayText)
Sets parameter value and display text. |
void |
setParameterDisplayText(java.lang.String name,
java.lang.String displayText)
Sets display text of a parameter with specified name. |
void |
setParameterValue(java.lang.String name,
java.lang.Object value)
sets one parameter value |
void |
setParameterValues(java.util.Map params)
set all parameter valuess |
void |
setTimeZone(com.ibm.icu.util.TimeZone timeZone)
Set the time zone information for the task. |
void |
setUserACL(java.lang.String[] acl)
set user's ACL. |
boolean |
validateParameters()
|
Field Detail |
---|
static final int TASK_UNKNOWN
static final int TASK_GETPARAMETERDEFINITION
static final int TASK_RUN
static final int TASK_RENDER
static final int TASK_RUNANDRENDER
static final int TASK_DATAEXTRACTION
static final int STATUS_NOT_STARTED
static final int STATUS_RUNNING
static final int STATUS_SUCCEEDED
static final int STATUS_FAILED
static final int STATUS_CANCELLED
static final int CONTINUE_ON_ERROR
static final int CANCEL_ON_ERROR
Method Detail |
---|
void setLocale(java.util.Locale locale)
locale
- the task localevoid setLocale(com.ibm.icu.util.ULocale locale)
locale
- the task localevoid setTimeZone(com.ibm.icu.util.TimeZone timeZone)
Only following tasks have the meaningful implementations:
timeZone
- the time zone information for the taskvoid setAppContext(java.util.Map context)
context
- -
task contexts in a map. The map contains name-value pairsjava.util.Locale getLocale()
com.ibm.icu.util.ULocale getULocale()
java.util.Map getAppContext()
IReportEngine getEngine()
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 scriptedint getID()
IReportRunnable getReportRunnable()
void setParameterValues(java.util.Map params)
params
- a hash map with all parametersvoid setParameterValue(java.lang.String name, java.lang.Object value)
name
- parameter namevalue
- parameter valuejava.util.HashMap getParameterValues()
java.lang.Object getParameterValue(java.lang.String name)
boolean validateParameters()
void setParameter(java.lang.String name, java.lang.Object value, java.lang.String displayText)
name
- parameter name.value
- value.displayText
- display text.java.lang.String getParameterDisplayText(java.lang.String name)
name
- parameter name.
void setParameterDisplayText(java.lang.String name, java.lang.String displayText)
name
- name of the parameter.displayText
- display text to set.void cancel()
void cancel(java.lang.Object signal)
boolean getCancelFlag()
int getStatus()
void setErrorHandlingOption(int option)
option
- the error handling mode.void close()
void setDataSource(org.eclipse.birt.core.archive.IDocArchiveReader dataSource)
dataSource
- data source archive.void setDataSource(org.eclipse.birt.core.archive.IDocArchiveReader dataSource, java.lang.String reportlet)
dataSource
- data source archive.reportlet
- the bookmark of the reportlet.java.util.List getErrors()
int getTaskType()
java.util.logging.Logger getLogger()
void setLogger(java.util.logging.Logger logger)
logger
- the logger used to output messages.void setUserACL(java.lang.String[] acl)
acl
- a string array, each element is a single SID.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |