Namespace: Consultingwerk.OERA
Interface 
IServiceAdapterWithInvokeTaskAsync Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object
Implemented by: Consultingwerk.OERA.ServiceAdapter

File:IServiceAdapterWithInvokeTaskAsync
Purpose:Interface to be implemented by ServiceAdapter implementations
that support the InvokeTask methods
Description:See SCL-246
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sat Oct 11 14:04:43 CET 2014
Notes:When async tasks are used, the client will need to provide
valid dataset handles in order to receive data from the
task. Datasets will be serialized as XLM or JSON from
the server and the data will be returned into the dataset
instances provided by the caller
The poContext object reference may be used to provide
context information to be returned in the AsyncTaskCompleted
event
Async task calls on the AppServer do receive the context
dataset. However the context dataset is not returned by to
the caller
This interface is no longer required to use. As of SCL-1045
the basic IServiceAdapter interface was enhanced to contain
all ServiceAdapter functionality. As such, all methods of
the ServiceAdapter class are directly accessible from the
FrameworkSettings:ServiceAdapter reference withour the
previous need to case to this interface.
Purpose: Raised when an Async Task has completed
Notes:



Top Method Summary
Options Name Purpose
+ HANDLE InvokeTaskAsync (character, character, character, handle, handle, handle, handle, handle, ISerializable, handle, Object) Invokes a method in a Task class asynchronously
+ HANDLE InvokeTaskAsync (character, character, character, handle, handle, handle, handle, ISerializable, handle, Object) Invokes a method in a Task class asynchronously
+ HANDLE InvokeTaskAsync (character, character, character, handle, handle, handle, ISerializable, handle, Object) Invokes a method in a Task class asynchronously
+ HANDLE InvokeTaskAsync (character, character, character, handle, handle, ISerializable, handle, Object) Invokes a method in a Task class asynchronously
+ HANDLE InvokeTaskAsync (character, character, character, handle, ISerializable, handle, Object) Invokes a method in a Task class.
+ HANDLE InvokeTaskAsync (character, character, character, ISerializable, handle, Object) Invokes a method in a Task class.

Top Event Summary
Options Name Purpose
+ AsyncTaskCompleted (Object, AsyncTaskCompletedEventArgs) Raised when an Async Task has completed


Method Detail
Top

PUBLIC HANDLE InvokeTaskAsync (character, character, character, handle, handle, handle, handle, handle, ISerializable, handle, Object)

Purpose: Invokes a method in a Task class asynchronously
Notes: When no MethodName is passed then "Invoke" will be executed as the
default task method

Parameters:
pcPartition CHARACTER
The name of the AppServer partition for this call or "" for the default partition
pcTaskName CHARACTER
The name of the task class
pcMethodName CHARACTER
The name of the business entity method to invoke
phDataset1 HANDLE
The handle of the first dataset to be passed to the task method
phDataset2 HANDLE
The handle of the second dataset to be passed to the task method
phDataset3 HANDLE
The handle of the third dataset to be passed to the task method
phDataset4 HANDLE
The handle of the fourth dataset to be passed to the task method
phDataset5 HANDLE
The handle of the fifth dataset to be passed to the task method
poParameter Consultingwerk.ISerializable
The serializable parameter object to the method
phContextDataset HANDLE
The handle of the context dataset for this call
poContext Progress.Lang.Object
The reference to the context object to be returned with the AsyncTaskCompleted event
Returns HANDLE
The handle of the async AppServer request
Top

PUBLIC HANDLE InvokeTaskAsync (character, character, character, handle, handle, handle, handle, ISerializable, handle, Object)

Purpose: Invokes a method in a Task class asynchronously
Notes: When no MethodName is passed then "Invoke" will be executed as the
default task method

Parameters:
pcPartition CHARACTER
The name of the AppServer partition for this call or "" for the default partition
pcTaskName CHARACTER
The name of the task class
pcMethodName CHARACTER
The name of the business entity method to invoke
phDataset1 HANDLE
The handle of the first dataset to be passed to the task method
phDataset2 HANDLE
The handle of the second dataset to be passed to the task method
phDataset3 HANDLE
The handle of the third dataset to be passed to the task method
phDataset4 HANDLE
The handle of the fourth dataset to be passed to the task method
poParameter Consultingwerk.ISerializable
The serializable parameter object to the method
phContextDataset HANDLE
The handle of the context dataset for this call
poContext Progress.Lang.Object
The reference to the context object to be returned with the AsyncTaskCompleted event
Returns HANDLE
The handle of the async AppServer request
Top

PUBLIC HANDLE InvokeTaskAsync (character, character, character, handle, handle, handle, ISerializable, handle, Object)

Purpose: Invokes a method in a Task class asynchronously
Notes: When no MethodName is passed then "Invoke" will be executed as the
default task method

Parameters:
pcPartition CHARACTER
The name of the AppServer partition for this call or "" for the default partition
pcTaskName CHARACTER
The name of the task class
pcMethodName CHARACTER
The name of the business entity method to invoke
phDataset1 HANDLE
The handle of the first dataset to be passed to the task method
phDataset2 HANDLE
The handle of the second dataset to be passed to the task method
phDataset3 HANDLE
The handle of the third dataset to be passed to the task method
poParameter Consultingwerk.ISerializable
The serializable parameter object to the method
phContextDataset HANDLE
The handle of the context dataset for this call
poContext Progress.Lang.Object
The reference to the context object to be returned with the AsyncTaskCompleted event
Returns HANDLE
The handle of the async AppServer request
Top

PUBLIC HANDLE InvokeTaskAsync (character, character, character, handle, handle, ISerializable, handle, Object)

Purpose: Invokes a method in a Task class asynchronously
Notes: When no MethodName is passed then "Invoke" will be executed as the
default task method

Parameters:
pcPartition CHARACTER
The name of the AppServer partition for this call or "" for the default partition
pcTaskName CHARACTER
The name of the task class
pcMethodName CHARACTER
The name of the business entity method to invoke
phDataset1 HANDLE
The handle of the first dataset to be passed to the task method
phDataset2 HANDLE
The handle of the second dataset to be passed to the task method
poParameter Consultingwerk.ISerializable
The serializable parameter object to the method
phContextDataset HANDLE
The handle of the context dataset for this call
poContext Progress.Lang.Object
The reference to the context object to be returned with the AsyncTaskCompleted event
Returns HANDLE
The handle of the async AppServer request
Top

PUBLIC HANDLE InvokeTaskAsync (character, character, character, handle, ISerializable, handle, Object)

Purpose: Invokes a method in a Task class.
Notes: When no MethodName is passed then "Invoke" will be executed as the
default task method

Parameters:
pcPartition CHARACTER
The name of the AppServer partition for this call or "" for the default partition
pcTaskName CHARACTER
The name of the task class
pcMethodName CHARACTER
The name of the business entity method to invoke
phDataset1 HANDLE
The handle of the first dataset to be passed to the task method
poParameter Consultingwerk.ISerializable
The serializable parameter object to the method
phContextDataset HANDLE
The handle of the context dataset for this call
poContext Progress.Lang.Object
The reference to the context object to be returned with the AsyncTaskCompleted event
Returns HANDLE
The handle of the async AppServer request
Top

PUBLIC HANDLE InvokeTaskAsync (character, character, character, ISerializable, handle, Object)

Purpose: Invokes a method in a Task class.
Notes: When no MethodName is passed then "Invoke" will be executed as the
default task method

Parameters:
pcPartition CHARACTER
The name of the AppServer partition for this call or "" for the default partition
pcTaskName CHARACTER
The name of the task class
pcMethodName CHARACTER
The name of the business entity method to invoke
poParameter Consultingwerk.ISerializable
The serializable parameter object to the method
phContextDataset HANDLE
The handle of the context dataset for this call
poContext Progress.Lang.Object
The reference to the context object to be returned with the AsyncTaskCompleted event
Returns HANDLE
The handle of the async AppServer request


Event Detail
Top

PUBLIC AsyncTaskCompleted (Object, AsyncTaskCompletedEventArgs)

Purpose: Raised when an Async Task has completed
Notes:

Parameters:
sender Progress.Lang.Object
The reference to the object that raised the event
e Consultingwerk.OERA.AsyncTaskCompletedEventArgs
The AsyncTaskCompletedEventArgs instance with the data for this event


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       15.04.2024 05:52:40