Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.eclipse.birt.report.engine.api
Interface IExtractionTask

All Superinterfaces:
  IEngineTask

All Known Subinterfaces:
  IDataExtractionTask

    public interface IExtractionTask

extends IEngineTask

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_DATASETPREVIEW, TASK_GETPARAMETERDEFINITION, TASK_RENDER, TASK_RUN, TASK_RUNANDRENDER, TASK_UNKNOWN`

Method Summary
`java.lang.Object` | `extract()` execute this extraction task
`void` | `extract(IExtractionOption option)` execute this extraction task
`void` | `setFilters(org.eclipse.birt.data.engine.api.IFilterDefinition[] filters)` the filter conditions
`void` | `setSorts(org.eclipse.birt.data.engine.api.ISortDefinition[] sorts)` set sorting conditions

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, setProgressMonitor, setStatusHandler, setTimeZone, setUserACL, validateParameters`

Method Detail

### setFilters

    void setFilters(org.eclipse.birt.data.engine.api.IFilterDefinition[] filters)

  the filter conditions

  Parameters:
    `filters` -

### setSorts

    void setSorts(org.eclipse.birt.data.engine.api.ISortDefinition[] sorts)

  set sorting conditions

  Parameters:
    `sorts` -

### extract

    java.lang.Object extract()
                             throws org.eclipse.birt.core.exception.BirtException

  execute this extraction task

  Returns:
    the extraction result
  Throws:
    `org.eclipse.birt.core.exception.BirtException`

### extract

    void extract(IExtractionOption option)
                 throws org.eclipse.birt.core.exception.BirtException

  execute this extraction task

  Parameters:
    `option` - the extraction option
  Throws:
    `org.eclipse.birt.core.exception.BirtException`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008 Actuate Corp. All rights reserved.