Packagestimulsoft.base.api
Classpublic class StiApiProvider
InheritanceStiApiProvider Inheritance flash.events.EventDispatcher
Subclasses StiApiProviderFlex


Public Properties
 PropertyDefined By
  application : String
StiApiProvider
  clientRepeatCount : int
StiApiProvider
  clientRequestTimeout : int
StiApiProvider
  featureNotSupported : String
[read-only]
StiApiProvider
  logger : Array
[static]
StiApiProvider
  provider : StiApiProvider
[static]
StiApiProvider
  useServerCache : Boolean
StiApiProvider
  variables : StiHashtable
[read-only]
StiApiProvider
Protected Properties
 PropertyDefined By
  currentTask : Object
[read-only]
StiApiProvider
  options : Class
[read-only]
StiApiProvider
Public Methods
 MethodDefined By
  
StiApiProvider(application:String)
StiApiProvider
  
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
[override] Redefining event handler of task start
StiApiProvider
Protected Methods
 MethodDefined By
  
addTask(type:String, data:* = null, progress:Object = null, fileName:String = null, tag:String = null, targetWindow:String = _self):int
Add a task in a queue
StiApiProvider
  
deleteTask():int
Delete a task from the queue
StiApiProvider
  
dispatchErrorFunction(message:String, data:* = null):void
Function of error processing
StiApiProvider
  
dispatchResultFunction(data:*):void
Successfull finishing operation function
StiApiProvider
  
getTaskService(type:String):*
Returns a service being used for working with the task server of the specified type
StiApiProvider
  
initEventListeners():void
Provider initialization
StiApiProvider
  
prepareData(data:*):ByteArray
Prepare data
StiApiProvider
  
restartTask():void
Run the current task once again for exacution
StiApiProvider
  
startNextTask():void
Run the first task in a queue (if exists)
StiApiProvider
  
startTask(task:Object, restart:Boolean = false):void
Run the task for execution
StiApiProvider
Events
 Event Summary Defined By
  
changeTitle
StiApiProvider
  
changeTitleResult
StiApiProvider
  
changeTitleStart
StiApiProvider
  
changeTitleStartTask
StiApiProvider
  
createReport
StiApiProvider
  
createReportProgress
StiApiProvider
  
createReportResult
StiApiProvider
  
createReportStart
StiApiProvider
  
createReportStartTask
StiApiProvider
  
designReport
StiApiProvider
  
designReportResult
StiApiProvider
  
designReportStart
StiApiProvider
  
designReportStartTask
StiApiProvider
  
exitDesigner
StiApiProvider
  
exitDesignerResult
StiApiProvider
  
exitDesignerStart
StiApiProvider
  
exitDesignerStartTask
StiApiProvider
  
exitViewer
StiApiProvider
  
exitViewerResult
StiApiProvider
  
exitViewerStart
StiApiProvider
  
exitViewerStartTask
StiApiProvider
  
exportReport
StiApiProvider
  
exportReportProgress
StiApiProvider
  
exportReportResult
StiApiProvider
  
exportReportStart
StiApiProvider
  
exportReportStartTask
StiApiProvider
  
getDialogInfoItems
StiApiProvider
  
getDialogInfoItemsProgress
StiApiProvider
  
getDialogInfoItemsResult
StiApiProvider
  
getDialogInfoItemsStart
StiApiProvider
  
getDialogInfoItemsStartTask
StiApiProvider
  
initializeProvider
StiApiProvider
  
initializeProviderProgress
StiApiProvider
  
initializeProviderResult
StiApiProvider
  
initializeProviderStart
StiApiProvider
  
initializeProviderStartTask
StiApiProvider
  
loadConfiguration
StiApiProvider
  
loadConfigurationProgress
StiApiProvider
  
loadConfigurationResult
StiApiProvider
  
loadConfigurationStart
StiApiProvider
  
loadConfigurationStartTask
StiApiProvider
  
loadData
StiApiProvider
  
loadDataProgress
StiApiProvider
  
loadDataResult
StiApiProvider
  
loadDataStart
StiApiProvider
  
loadDataStartTask
StiApiProvider
  
loadDocumentFile
StiApiProvider
  
loadDocumentFileCancel
StiApiProvider
  
loadDocumentFileProgress
StiApiProvider
  
loadDocumentFileResult
StiApiProvider
  
loadDocumentFileStart
StiApiProvider
  
loadDocumentFileStartAction
StiApiProvider
  
loadDocumentFileStartTask
StiApiProvider
  
loadImage
StiApiProvider
  
loadImageProgress
StiApiProvider
  
loadImageResult
StiApiProvider
  
loadImageStart
StiApiProvider
  
loadImageStartTask
StiApiProvider
  
loadLanguage
StiApiProvider
  
loadLanguageProgress
StiApiProvider
  
loadLanguageResult
StiApiProvider
  
loadLanguageStart
StiApiProvider
  
loadLanguageStartTask
StiApiProvider
  
loadReport
StiApiProvider
  
loadReportCode
StiApiProvider
  
loadReportCodeProgress
StiApiProvider
  
loadReportCodeResult
StiApiProvider
  
loadReportCodeStart
StiApiProvider
  
loadReportCodeStartTask
StiApiProvider
  
loadReportFile
StiApiProvider
  
loadReportFileCancel
StiApiProvider
  
loadReportFileProgress
StiApiProvider
  
loadReportFileResult
StiApiProvider
  
loadReportFileStart
StiApiProvider
  
loadReportFileStartAction
StiApiProvider
  
loadReportFileStartTask
StiApiProvider
  
loadReportProgress
StiApiProvider
  
loadReportResult
StiApiProvider
  
loadReportStart
StiApiProvider
  
loadReportStartTask
StiApiProvider
  
previewReport
StiApiProvider
  
previewReportProgress
StiApiProvider
  
previewReportResult
StiApiProvider
  
previewReportStart
StiApiProvider
  
previewReportStartTask
StiApiProvider
  
retrieveColumns
StiApiProvider
  
retrieveColumnsProgress
StiApiProvider
  
retrieveColumnsResult
StiApiProvider
  
retrieveColumnsStart
StiApiProvider
  
retrieveColumnsStartTask
StiApiProvider
  
saveConfiguration
StiApiProvider
  
saveConfigurationProgress
StiApiProvider
  
saveConfigurationResult
StiApiProvider
  
saveConfigurationStart
StiApiProvider
  
saveConfigurationStartTask
StiApiProvider
  
saveReport
StiApiProvider
  
saveReportAs
StiApiProvider
  
saveReportAsCancel
StiApiProvider
  
saveReportAsProgress
StiApiProvider
  
saveReportAsResult
StiApiProvider
  
saveReportAsStart
StiApiProvider
  
saveReportAsStartAction
StiApiProvider
  
saveReportAsStartTask
StiApiProvider
  
saveReportCancel
StiApiProvider
  
saveReportProgress
StiApiProvider
  
saveReportResult
StiApiProvider
  
saveReportStart
StiApiProvider
  
saveReportStartTask
StiApiProvider
  
sendEmailReport
StiApiProvider
  
sendEmailReportProgress
StiApiProvider
  
sendEmailReportResult
StiApiProvider
  
sendEmailReportStart
StiApiProvider
  
sendEmailReportStartTask
StiApiProvider
  
sendExportedReport
StiApiProvider
  
sendExportedReportProgress
StiApiProvider
  
sendExportedReportResult
StiApiProvider
  
sendExportedReportStart
StiApiProvider
  
sendExportedReportStartTask
StiApiProvider
  
testConnection
StiApiProvider
  
testConnectionProgress
StiApiProvider
  
testConnectionResult
StiApiProvider
  
testConnectionStart
StiApiProvider
  
testConnectionStartTask
StiApiProvider
Public Constants
 ConstantDefined By
  AppDesignerFx : String = DesignerFx
[static]
StiApiProvider
  AppViewerFx : String = ViewerFx
[static]
StiApiProvider
Property Detail
applicationproperty
application:String


Implementation
    public function get application():String
    public function set application(value:String):void
clientRepeatCountproperty 
clientRepeatCount:int


Implementation
    public function get clientRepeatCount():int
    public function set clientRepeatCount(value:int):void
clientRequestTimeoutproperty 
clientRequestTimeout:int


Implementation
    public function get clientRequestTimeout():int
    public function set clientRequestTimeout(value:int):void
currentTaskproperty 
currentTask:Object  [read-only]


Implementation
    protected function get currentTask():Object
featureNotSupportedproperty 
featureNotSupported:String  [read-only]


Implementation
    public function get featureNotSupported():String
loggerproperty 
logger:Array


Implementation
    public static function get logger():Array
    public static function set logger(value:Array):void
optionsproperty 
options:Class  [read-only]


Implementation
    protected function get options():Class
providerproperty 
provider:StiApiProvider


Implementation
    public static function get provider():StiApiProvider
    public static function set provider(value:StiApiProvider):void
useServerCacheproperty 
useServerCache:Boolean


Implementation
    public function get useServerCache():Boolean
    public function set useServerCache(value:Boolean):void
variablesproperty 
variables:StiHashtable  [read-only]


Implementation
    public function get variables():StiHashtable
Constructor Detail
StiApiProvider()Constructor
public function StiApiProvider(application:String)



Parameters
application:String
Method Detail
addEventListener()method
override public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void

Redefining event handler of task start

Parameters

type:String
 
listener:Function
 
useCapture:Boolean (default = false)
 
priority:int (default = 0)
 
useWeakReference:Boolean (default = false)

addTask()method 
protected function addTask(type:String, data:* = null, progress:Object = null, fileName:String = null, tag:String = null, targetWindow:String = _self):int

Add a task in a queue

Parameters

type:String
 
data:* (default = null)
 
progress:Object (default = null)
 
fileName:String (default = null)
 
tag:String (default = null)
 
targetWindow:String (default = _self)

Returns
int
deleteTask()method 
protected function deleteTask():int

Delete a task from the queue

Returns
int
dispatchErrorFunction()method 
protected function dispatchErrorFunction(message:String, data:* = null):void

Function of error processing

Parameters

message:String
 
data:* (default = null)

dispatchResultFunction()method 
protected function dispatchResultFunction(data:*):void

Successfull finishing operation function

Parameters

data:*

getTaskService()method 
protected function getTaskService(type:String):*

Returns a service being used for working with the task server of the specified type

Parameters

type:String

Returns
*
initEventListeners()method 
protected function initEventListeners():void

Provider initialization

prepareData()method 
protected function prepareData(data:*):ByteArray

Prepare data

Parameters

data:*

Returns
ByteArray
restartTask()method 
protected function restartTask():void

Run the current task once again for exacution

startNextTask()method 
protected function startNextTask():void

Run the first task in a queue (if exists)

startTask()method 
protected function startTask(task:Object, restart:Boolean = false):void

Run the task for execution

Parameters

task:Object
 
restart:Boolean (default = false)

Event Detail
changeTitle Event
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

changeTitleResult Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

changeTitleStart Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

changeTitleStartTask Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

createReport Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

createReportProgress Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

createReportResult Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

createReportStart Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

createReportStartTask Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

designReport Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

designReportResult Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

designReportStart Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

designReportStartTask Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

exitDesigner Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

exitDesignerResult Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

exitDesignerStart Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

exitDesignerStartTask Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

exitViewer Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

exitViewerResult Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

exitViewerStart Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

exitViewerStartTask Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

exportReport Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

exportReportProgress Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

exportReportResult Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

exportReportStart Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

exportReportStartTask Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

getDialogInfoItems Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

getDialogInfoItemsProgress Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

getDialogInfoItemsResult Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

getDialogInfoItemsStart Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

getDialogInfoItemsStartTask Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

initializeProvider Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

initializeProviderProgress Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

initializeProviderResult Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

initializeProviderStart Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

initializeProviderStartTask Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadConfiguration Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadConfigurationProgress Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadConfigurationResult Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadConfigurationStart Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadConfigurationStartTask Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadData Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadDataProgress Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadDataResult Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadDataStart Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadDataStartTask Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadDocumentFile Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadDocumentFileCancel Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadDocumentFileProgress Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadDocumentFileResult Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadDocumentFileStart Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadDocumentFileStartAction Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadDocumentFileStartTask Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadImage Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadImageProgress Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadImageResult Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadImageStart Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadImageStartTask Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadLanguage Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadLanguageProgress Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadLanguageResult Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadLanguageStart Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadLanguageStartTask Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadReport Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadReportCode Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadReportCodeProgress Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadReportCodeResult Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadReportCodeStart Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadReportCodeStartTask Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadReportFile Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadReportFileCancel Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadReportFileProgress Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadReportFileResult Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadReportFileStart Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadReportFileStartAction Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadReportFileStartTask Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadReportProgress Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadReportResult Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadReportStart Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

loadReportStartTask Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

previewReport Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

previewReportProgress Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

previewReportResult Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

previewReportStart Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

previewReportStartTask Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

retrieveColumns Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

retrieveColumnsProgress Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

retrieveColumnsResult Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

retrieveColumnsStart Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

retrieveColumnsStartTask Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

saveConfiguration Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

saveConfigurationProgress Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

saveConfigurationResult Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

saveConfigurationStart Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

saveConfigurationStartTask Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

saveReport Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

saveReportAs Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

saveReportAsCancel Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

saveReportAsProgress Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

saveReportAsResult Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

saveReportAsStart Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

saveReportAsStartAction Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

saveReportAsStartTask Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

saveReportCancel Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

saveReportProgress Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

saveReportResult Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

saveReportStart Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

saveReportStartTask Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

sendEmailReport Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

sendEmailReportProgress Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

sendEmailReportResult Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

sendEmailReportStart Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

sendEmailReportStartTask Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

sendExportedReport Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

sendExportedReportProgress Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

sendExportedReportResult Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

sendExportedReportStart Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

sendExportedReportStartTask Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

testConnection Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

testConnectionProgress Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

testConnectionResult Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

testConnectionStart Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

testConnectionStartTask Event  
Event Object Type: stimulsoft.base.api.events.StiApiProviderEvent

Constant Detail
AppDesignerFxConstant
public static const AppDesignerFx:String = DesignerFx

AppViewerFxConstant 
public static const AppViewerFx:String = ViewerFx





Mon Mar 27 2017, 09:08 AM +03:00