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

File:IServiceAdapter
Purpose:Interface allowing customized implementations of the
OERA ServiceAdapter (client side)
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Tue Jun 01 09:25:47 CEST 2010

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
+ FetchDataset (character, character, dataset-handle) Returns an Empty Dataset (schema) to the client.
+ FetchDataset (character, character, dataset-handle, handle) Returns an Empty Dataset (schema) to the client.
+ InvokeMethod (character, character, character, dataset-handle, ISerializable) Invokes a custom method of the BusinessEntity.
+ InvokeMethod (character, character, character, dataset-handle, ISerializable, handle) Invokes a custom method of the BusinessEntity.
+ InvokeTask (character, character, character, dataset-handle, dataset-handle, dataset-handle, dataset-handle, dataset-handle, ISerializable) Invokes a method in a Task class.
+ InvokeTask (character, character, character, dataset-handle, dataset-handle, dataset-handle, dataset-handle, dataset-handle, ISerializable, handle) Invokes a method in a Task class.
+ InvokeTask (character, character, character, dataset-handle, dataset-handle, dataset-handle, dataset-handle, ISerializable) Invokes a method in a Task class.
+ InvokeTask (character, character, character, dataset-handle, dataset-handle, dataset-handle, dataset-handle, ISerializable, handle) Invokes a method in a Task class.
+ InvokeTask (character, character, character, dataset-handle, dataset-handle, dataset-handle, ISerializable) Invokes a method in a Task class.
+ InvokeTask (character, character, character, dataset-handle, dataset-handle, dataset-handle, ISerializable, handle) Invokes a method in a Task class.
+ InvokeTask (character, character, character, dataset-handle, dataset-handle, ISerializable) Invokes a method in a Task class.
+ InvokeTask (character, character, character, dataset-handle, dataset-handle, ISerializable, handle) Invokes a method in a Task class.
+ InvokeTask (character, character, character, dataset-handle, ISerializable) Invokes a method in a Task class.
+ InvokeTask (character, character, character, dataset-handle, ISerializable, handle) Invokes a method in a Task class.
+ InvokeTask (character, character, character, ISerializable) Invokes a method in a Task class.
+ InvokeTask (character, character, character, ISerializable, handle) Invokes a method in a Task class.
+ 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, handle, ISerializable, 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, handle, ISerializable, 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, handle, ISerializable, 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, handle, ISerializable, 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, handle, ISerializable, Object) Invokes a method in a Task class.
+ HANDLE InvokeTaskAsync (character, character, character, ISerializable, handle, Object) Invokes a method in a Task class.
+ HANDLE InvokeTaskAsync (character, character, character, ISerializable, Object) Invokes a method in a Task class.
+ RetrieveData (character, character, IFetchDataRequest, dataset-handle) Reads data from the Backend
+ RetrieveData (character, character, IFetchDataRequest, dataset-handle, handle) Reads data from the Backend
+ SubmitData (character, character, dataset-handle) Saves modified (Create, Update, Delete) data to a Business Entity
+ SubmitData (character, character, dataset-handle, character) Saves modified (Create, Update, Delete) data to a Business Entity
+ SubmitData (character, character, dataset-handle, character, handle) Saves modified (Create, Update, Delete) data to a Business Entity
+ SubmitData (character, character, dataset-handle, character, ISerializable) Saves modified (Create, Update, Delete) data to a Business Entity
+ SubmitData (character, character, dataset-handle, character, ISerializable, handle) Saves modified (Create, Update, Delete) data to a Business Entity
+ SubmitData (character, character, dataset-handle, ISerializable) Saves modified (Create, Update, Delete) data to a Business Entity
+ SubmitData (character, character, dataset-handle, ISerializable, handle) Saves modified (Create, Update, Delete) data to a Business Entity
+ LOGICAL ValidateEntityName (character, character) Validates a business entity name

Top Event Summary
Options Name Purpose
+ AsyncTaskCompleted (Object, AsyncTaskCompletedEventArgs) Raised when an Async Task has completed
+ CollectContextFromServer (Object, EventArgs) Raised after the ServiceAdapter has performed an Request to the AppServer
+ PrepareContextForServer (Object, EventArgs) Raised before the ServiceAdapter performs an Request to the AppServer


Method Detail
Top

PUBLIC FetchDataset (character, character, dataset-handle)
Purpose: Returns an Empty Dataset (schema) to the client.
Notes: The caller of this method is responsible to clean up the Dataset
when no longer used! The called should always invoke this method
with the dataset output parameter BY-REFERENCE!

Parameters:
pcPartition CHARACTER
The name of the AppServer partition for this call or "" for the default partition
pcEntityName CHARACTER
The name of the business entity
phDataset DATASET-HANDLE
OUTPUT DATASET-HANDLE The empty dataset
Top

PUBLIC FetchDataset (character, character, dataset-handle, handle)
Purpose: Returns an Empty Dataset (schema) to the client.
Notes: The caller of this method is responsible to clean up the Dataset
when no longer used! The called should always invoke this method
with the dataset output parameter BY-REFERENCE!

Parameters:
pcPartition CHARACTER
The name of the AppServer partition for this call or "" for the default partition
pcEntityName CHARACTER
The name of the business entity
phDataset DATASET-HANDLE
OUTPUT DATASET-HANDLE The empty dataset
phContextDataset HANDLE
The handle of the context dataset for this call
Top

PUBLIC InvokeMethod (character, character, character, dataset-handle, ISerializable)
Purpose: Invokes a custom method of the BusinessEntity.
Notes: When the poParameter is expected to just return values, it must still
be passed in to this method

Parameters:
pcPartition CHARACTER
The name of the AppServer partition for this call or "" for the default partition
pcEntityName CHARACTER
The name of the business entity
pcMethodName CHARACTER
The name of the business entity method to invoke
phDataset DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the dataset of the business entity, optionally INPUT, optionally OUTPUT
poParameter Consultingwerk.ISerializable
The serializable parameter object to the method
Top

PUBLIC InvokeMethod (character, character, character, dataset-handle, ISerializable, handle)
Purpose: Invokes a custom method of the BusinessEntity.
Notes: The phContextDataset parameter is intended to be passed by-reference

Parameters:
pcPartition CHARACTER
The name of the AppServer partition for this call or "" for the default partition
pcEntityName CHARACTER
The name of the business entity
pcMethodName CHARACTER
The name of the business entity method to invoke
phDataset DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the dataset of the business entity, optionally INPUT, optionally OUTPUT
poParameter Consultingwerk.ISerializable
The serializable parameter object to the method
phContextDataset HANDLE
The handle of the context dataset for this call
Top

PUBLIC InvokeTask (character, character, character, dataset-handle, dataset-handle, dataset-handle, dataset-handle, dataset-handle, ISerializable)
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 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the first dataset to be passed to the task method
phDataset2 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the second dataset to be passed to the task method
phDataset3 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the third dataset to be passed to the task method
phDataset4 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the fourth dataset to be passed to the task method
phDataset5 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the fifth dataset to be passed to the task method
poParameter Consultingwerk.ISerializable
The serializable parameter object to the method
Top

PUBLIC InvokeTask (character, character, character, dataset-handle, dataset-handle, dataset-handle, dataset-handle, dataset-handle, ISerializable, handle)
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 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the first dataset to be passed to the task method
phDataset2 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the second dataset to be passed to the task method
phDataset3 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the third dataset to be passed to the task method
phDataset4 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the fourth dataset to be passed to the task method
phDataset5 DATASET-HANDLE
INPUT-OUTPUT DATASET-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
Top

PUBLIC InvokeTask (character, character, character, dataset-handle, dataset-handle, dataset-handle, dataset-handle, ISerializable)
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 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the first dataset to be passed to the task method
phDataset2 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the second dataset to be passed to the task method
phDataset3 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the third dataset to be passed to the task method
phDataset4 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the fourth dataset to be passed to the task method
poParameter Consultingwerk.ISerializable
The serializable parameter object to the method
Top

PUBLIC InvokeTask (character, character, character, dataset-handle, dataset-handle, dataset-handle, dataset-handle, ISerializable, handle)
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 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the first dataset to be passed to the task method
phDataset2 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the second dataset to be passed to the task method
phDataset3 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the third dataset to be passed to the task method
phDataset4 DATASET-HANDLE
INPUT-OUTPUT DATASET-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
Top

PUBLIC InvokeTask (character, character, character, dataset-handle, dataset-handle, dataset-handle, ISerializable)
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 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the first dataset to be passed to the task method
phDataset2 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the second dataset to be passed to the task method
phDataset3 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the third dataset to be passed to the task method
poParameter Consultingwerk.ISerializable
The serializable parameter object to the method
Top

PUBLIC InvokeTask (character, character, character, dataset-handle, dataset-handle, dataset-handle, ISerializable, handle)
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 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the first dataset to be passed to the task method
phDataset2 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the second dataset to be passed to the task method
phDataset3 DATASET-HANDLE
INPUT-OUTPUT DATASET-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
Top

PUBLIC InvokeTask (character, character, character, dataset-handle, dataset-handle, ISerializable)
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 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the first dataset to be passed to the task method
phDataset2 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the second dataset to be passed to the task method
poParameter Consultingwerk.ISerializable
The serializable parameter object to the method
Top

PUBLIC InvokeTask (character, character, character, dataset-handle, dataset-handle, ISerializable, handle)
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 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the first dataset to be passed to the task method
phDataset2 DATASET-HANDLE
INPUT-OUTPUT DATASET-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
Top

PUBLIC InvokeTask (character, character, character, dataset-handle, ISerializable)
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 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the first dataset to be passed to the task method
poParameter Consultingwerk.ISerializable
The serializable parameter object to the method
Top

PUBLIC InvokeTask (character, character, character, dataset-handle, ISerializable, handle)
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 DATASET-HANDLE
INPUT-OUTPUT DATASET-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
Top

PUBLIC InvokeTask (character, character, character, ISerializable)
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
Top

PUBLIC InvokeTask (character, character, character, ISerializable, handle)
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
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, handle, ISerializable, 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
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, handle, ISerializable, 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
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, handle, ISerializable, 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
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, handle, ISerializable, 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
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, handle, ISerializable, 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
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
Top

PUBLIC HANDLE InvokeTaskAsync (character, character, character, ISerializable, 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
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 RetrieveData (character, character, IFetchDataRequest, dataset-handle)
Purpose: Reads data from the Backend
Notes: Request Parameters are send using the IFetchDataRequest object

Parameters:
pcPartition CHARACTER
The name of the AppServer partition for this call or "" for the default partition
pcEntityName CHARACTER
The name of the business entity
poFetchDataRequest Consultingwerk.OERA.IFetchDataRequest
The IFetchDataRequest object with the data for this request
phDataSet DATASET-HANDLE
OUTPUT DATASET-HANDLE The resulting dataset
Top

PUBLIC RetrieveData (character, character, IFetchDataRequest, dataset-handle, handle)
Purpose: Reads data from the Backend
Notes: Request Parameters are send using the IFetchDataRequest object
The phContextDataset parameter is intended to be passed by-reference

Parameters:
pcPartition CHARACTER
The name of the AppServer partition for this call or "" for the default partition
pcEntityName CHARACTER
The name of the business entity
poFetchDataRequest Consultingwerk.OERA.IFetchDataRequest
The IFetchDataRequest object with the data for this request
phDataSet DATASET-HANDLE
OUTPUT DATASET-HANDLE The resulting dataset
phContextDataset HANDLE
The handle of the context dataset for this call
Top

PUBLIC SubmitData (character, character, dataset-handle)
Purpose: Saves modified (Create, Update, Delete) data to a Business Entity
Notes: It's recommended but not required to just pass a changes dataset

Parameters:
pcPartition CHARACTER
The name of the AppServer partition for this call or "" for the default partition
pcEntityName CHARACTER
The name of the business entity
hChangesDataset DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The dataset with the modifications to the submitted
Top

PUBLIC SubmitData (character, character, dataset-handle, character)
Purpose: Saves modified (Create, Update, Delete) data to a Business Entity
Notes: It's recommended but not required to just pass a changes dataset

Parameters:
pcPartition CHARACTER
The name of the AppServer partition for this call or "" for the default partition
pcEntityName CHARACTER
The name of the business entity
hChangesDataset DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The dataset with the modifications to the submitted
pcContext CHARACTER
INPUT-OUTPUT The context to be passed to the business entity
Top

PUBLIC SubmitData (character, character, dataset-handle, character, handle)
Purpose: Saves modified (Create, Update, Delete) data to a Business Entity
Notes: It's recommended but not required to just pass a changes dataset
The phContextDataset parameter is intended to be passed by-reference

Parameters:
pcPartition CHARACTER
The name of the AppServer partition for this call or "" for the default partition
pcEntityName CHARACTER
The name of the business entity
hChangesDataset DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The dataset with the modifications to the submitted
pcContext CHARACTER
INPUT-OUTPUT The context to be passed to the business entity
phContextDataset HANDLE
The handle of the context dataset for this call
Top

PUBLIC SubmitData (character, character, dataset-handle, character, ISerializable)
Purpose: Saves modified (Create, Update, Delete) data to a Business Entity
Notes: It's recommended but not required to just pass a changes dataset

Parameters:
pcPartition CHARACTER
The name of the AppServer partition for this call or "" for the default partition
pcEntityName CHARACTER
The name of the business entity
hChangesDataset DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The dataset with the modifications to the submitted
pcContext CHARACTER
INPUT-OUTPUT The context to be passed to the business entity
poParameter Consultingwerk.ISerializable
An optional serializable parameter object to be exchanged with the business entity
Top

PUBLIC SubmitData (character, character, dataset-handle, character, ISerializable, handle)
Purpose: Saves modified (Create, Update, Delete) data to a Business Entity
Notes: It's recommended but not required to just pass a changes dataset
The phContextDataset parameter is intended to be passed by-reference

Parameters:
pcPartition CHARACTER
The name of the AppServer partition for this call or "" for the default partition
pcEntityName CHARACTER
The name of the business entity
hChangesDataset DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The dataset with the modifications to the submitted
pcContext CHARACTER
INPUT-OUTPUT The context to be passed to the business entity
poParameter Consultingwerk.ISerializable
An optional serializable parameter object to be exchanged with the business entity
phContextDataset HANDLE
The handle of the context dataset for this call
Top

PUBLIC SubmitData (character, character, dataset-handle, ISerializable)
Purpose: Saves modified (Create, Update, Delete) data to a Business Entity
Notes: It's recommended but not required to just pass a changes dataset

Parameters:
pcPartition CHARACTER
The name of the AppServer partition for this call or "" for the default partition
pcEntityName CHARACTER
The name of the business entity
hChangesDataset DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The dataset with the modifications to the submitted
poParameter Consultingwerk.ISerializable
An optional serializable parameter object to be exchanged with the business entity
Top

PUBLIC SubmitData (character, character, dataset-handle, ISerializable, handle)
Purpose: Saves modified (Create, Update, Delete) data to a Business Entity
Notes: It's recommended but not required to just pass a changes dataset
The phContextDataset parameter is intended to be passed by-reference

Parameters:
pcPartition CHARACTER
The name of the AppServer partition for this call or "" for the default partition
pcEntityName CHARACTER
The name of the business entity
hChangesDataset DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The dataset with the modifications to the submitted
poParameter Consultingwerk.ISerializable
An optional serializable parameter object to be exchanged with the business entity
phContextDataset HANDLE
The handle of the context dataset for this call
Top

PUBLIC LOGICAL ValidateEntityName (character, character)
Purpose: Validates a business entity name
Notes: Typically used by the extensions to the OpenEdge Architect Visual
Designer

Parameters:
pcPartition CHARACTER
The name of the AppServer partition for this call or "" for the default partition
pcEntityName CHARACTER
The name of the business entity
Returns LOGICAL
Logical value indicating if the Business Entity name if valid


Event Detail
Top

PUBLIC AsyncTaskCompleted (Object, AsyncTaskCompletedEventArgs)
Purpose: Raised when an Async Task has completed
Notes:

Parameters:
sender Progress.Lang.Object
The object that raised the AsyncTaskCompleted event
e Consultingwerk.OERA.AsyncTaskCompletedEventArgs
The AsyncTaskCompletedEventArgs with the data for the event
Top

PUBLIC CollectContextFromServer (Object, EventArgs)
Purpose: Raised after the ServiceAdapter has performed an Request to the AppServer
Notes:

Parameters:
sender Progress.Lang.Object
The object that raised the CollectContextFromServer event
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs with the data for the event
Top

PUBLIC PrepareContextForServer (Object, EventArgs)
Purpose: Raised before the ServiceAdapter performs an Request to the AppServer
Notes:

Parameters:
sender Progress.Lang.Object
The object that raised the PrepareContextForRequest event
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs with the data for the event


©2006-2016 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.08.2016 08:30:12