Namespace: Consultingwerk.OERA
Class 
ServiceAdapter Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object
Implements: Consultingwerk.OERA.IServiceAdapter, Consultingwerk.OERA.IServiceAdapterWithContextDataset, Consultingwerk.OERA.IServiceAdapterWithContextEvents, Consultingwerk.OERA.IServiceAdapterWithInvokeTask, Consultingwerk.OERA.IServiceAdapterWithInvokeTaskAsync, Consultingwerk.OERA.IServiceAdapterWithSubmitDataParameter

File:ServiceAdapter
Purpose:Default OERA ServiceAdapter implementation
Syntax:Automatically instantiated when accessing the
Consultingwerk.Framework.FrameworkSettings:ServiceAdapter
for the first time in a session
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Tue Jun 01 09:27:33 CEST 2010
Notes:The OERA ServiceAdapter is the only class of the
SmartComponent Library framework that actually communicates
with the Backend for Data-Retrieval.
Supports custom LogEntryType:CustomLogEntries by using
the Log entry type stored in the CUSTOM_LOG_ENTRY property
(Default is "ServiceAdapter")



Top Method Summary
Options Name Purpose
# HANDLE ConnectService (character) Returns the handle to the AppServer partition associated with This SmartDataAdapter
# HANDLE ConnectService (character, character) Returns the handle to the AppServer partition associated with This SmartDataAdapter
+ 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.
# LOGICAL HandleDisconnection (character, character) Handles disconnect issues by attempting to reconnect to the AppServer
+ 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.
+ Progress.Lang.Object InvokeTask (character, character, character) Invokes a method in a Task class.
+ Progress.Lang.Object InvokeTask (character, character, character, dataset-handle, dataset-handle, dataset-handle, dataset-handle, dataset-handle, ISerializable) Invokes a method in a Task class.
+ Progress.Lang.Object InvokeTask (character, character, character, dataset-handle, dataset-handle, dataset-handle, dataset-handle, dataset-handle, ISerializable, handle) Invokes a method in a Task class.
+ Progress.Lang.Object InvokeTask (character, character, character, dataset-handle, dataset-handle, dataset-handle, dataset-handle, ISerializable) Invokes a method in a Task class.
+ Progress.Lang.Object InvokeTask (character, character, character, dataset-handle, dataset-handle, dataset-handle, dataset-handle, ISerializable, handle) Invokes a method in a Task class.
+ Progress.Lang.Object InvokeTask (character, character, character, dataset-handle, dataset-handle, dataset-handle, ISerializable) Invokes a method in a Task class.
+ Progress.Lang.Object InvokeTask (character, character, character, dataset-handle, dataset-handle, dataset-handle, ISerializable, handle) Invokes a method in a Task class.
+ Progress.Lang.Object InvokeTask (character, character, character, dataset-handle, dataset-handle, ISerializable) Invokes a method in a Task class.
+ Progress.Lang.Object InvokeTask (character, character, character, dataset-handle, dataset-handle, ISerializable, handle) Invokes a method in a Task class.
+ Progress.Lang.Object InvokeTask (character, character, character, dataset-handle, ISerializable) Invokes a method in a Task class.
+ Progress.Lang.Object InvokeTask (character, character, character, dataset-handle, ISerializable, handle) Invokes a method in a Task class.
+ Progress.Lang.Object InvokeTask (character, character, character, ISerializable) Invokes a method in a Task class.
+ Progress.Lang.Object 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.
+ InvokeTaskAsyncNoOutput (character, character, character, handle, handle, handle, handle, handle, ISerializable, handle, Object) Invokes a method in a Task class asynchronously
+ InvokeTaskAsyncNoOutput (character, character, character, handle, handle, handle, handle, handle, ISerializable, Object) Invokes a method in a Task class asynchronously
+ InvokeTaskAsyncNoOutput (character, character, character, handle, handle, handle, handle, ISerializable, handle, Object) Invokes a method in a Task class asynchronously
+ InvokeTaskAsyncNoOutput (character, character, character, handle, handle, handle, handle, ISerializable, Object) Invokes a method in a Task class asynchronously
+ InvokeTaskAsyncNoOutput (character, character, character, handle, handle, handle, ISerializable, handle, Object) Invokes a method in a Task class asynchronously
+ InvokeTaskAsyncNoOutput (character, character, character, handle, handle, handle, ISerializable, Object) Invokes a method in a Task class asynchronously
+ InvokeTaskAsyncNoOutput (character, character, character, handle, handle, ISerializable, handle, Object) Invokes a method in a Task class asynchronously
+ InvokeTaskAsyncNoOutput (character, character, character, handle, handle, ISerializable, Object) Invokes a method in a Task class asynchronously
+ InvokeTaskAsyncNoOutput (character, character, character, handle, ISerializable, handle, Object) Invokes a method in a Task class.
+ InvokeTaskAsyncNoOutput (character, character, character, handle, ISerializable, Object) Invokes a method in a Task class.
+ InvokeTaskAsyncNoOutput (character, character, character, ISerializable, handle, Object) Invokes a method in a Task class.
+ InvokeTaskAsyncNoOutput (character, character, character, ISerializable, Object) Invokes a method in a Task class.
+ OnAsyncTaskCompleted (AsyncTaskCompletedEventArgs) Raises the AsyncTaskCompleted
# OnCollectContextFromServer (EventArgs) Raises the CollectContextFromServer
# OnExiting (EventArgs) Raises the Existing event
# OnPrepareContextForServer (EventArgs) Raises the PrepareContextForServer
+ OnRetrieveDataAsyncCompleted (RetrieveDataAsyncCompletedEventArgs) Raises the RetrieveDataAsyncCompleted event
+ RetrieveData (character, character, IFetchDataRequest, dataset-handle) Reads data from the Backend
+ RetrieveData (character, character, IFetchDataRequest, dataset-handle, handle) Reads data from the Backend
+ HANDLE RetrieveDataAsync (character, character, IFetchDataRequest, dataset-handle) Reads data from the Backend asynchronously
+ HANDLE RetrieveDataAsync (character, character, IFetchDataRequest, dataset-handle, handle) Reads data from the Backend asynchronously
+ 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 or business task name
# WriteLogMessage (character, character, character, character) Writes a message to the log file

Top Constructor Summary
Options Name Purpose
+ ServiceAdapter () Constructor for the ServiceAdapter class

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
+ Exiting (Object, EventArgs) Raised when Exiting due to a lost AppServer connection
+ PrepareContextForServer (Object, EventArgs) Raised before the ServiceAdapter performs an Request to the AppServer
+ RetrieveDataAsyncCompleted (Object, RetrieveDataAsyncCompletedEventArgs) Raised when an async RetrieveData call has completed

Top Property Summary
Options Name Purpose
+ CHARACTER AppServerPartition
+ Consultingwerk.OERA.OptionsOnDisconnectEnum BehaviorOnDisconnect
+ LOGICAL BlockedByReconnectDialog
+ CHARACTER CUSTOM_LOG_ENTRY
+ LOGICAL LoggingActive
+ CHARACTER ServiceInterfacePath


Method Detail
Top

PROTECTED HANDLE ConnectService (character)

Purpose: Returns the handle to the AppServer partition associated with
This SmartDataAdapter
Notes:

Parameters:
pcPartition CHARACTER
The name of the AppServer partition
Returns HANDLE
The handle of the AppServer partition of SESSION:HANDLE
Top

PROTECTED HANDLE ConnectService (character, character)

Purpose: Returns the handle to the AppServer partition associated with
This SmartDataAdapter
Notes: This variant of the method should be overridden in case customers
need to determine the default partion name based on the business
service accessed

Parameters:
pcPartition CHARACTER
The name of the AppServer partition
pcBusinessServiceName CHARACTER
The name of the Business Service
Returns HANDLE
The handle of the AppServer partition of SESSION:HANDLE
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

PROTECTED LOGICAL HandleDisconnection (character, character)

Purpose: Handles disconnect issues by attempting to reconnect to the AppServer
Notes:

Parameters:
pcPartition CHARACTER
The AppServer partition
pcErrorMessage CHARACTER
The original error message
Returns LOGICAL
Logicla value indicating if the connection could be re-established or the issue should be ignored
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 Progress.Lang.Object InvokeTask (character, character, character)

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
Returns Progress.Lang.Object
The return object of the method
Top

PUBLIC Progress.Lang.Object 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
Returns Progress.Lang.Object
The return object of the method
Top

PUBLIC Progress.Lang.Object 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
Returns Progress.Lang.Object
The return object of the method
Top

PUBLIC Progress.Lang.Object 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
Returns Progress.Lang.Object
The return object of the method
Top

PUBLIC Progress.Lang.Object 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
Returns Progress.Lang.Object
The return object of the method
Top

PUBLIC Progress.Lang.Object 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
Returns Progress.Lang.Object
The return object of the method
Top

PUBLIC Progress.Lang.Object 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
Returns Progress.Lang.Object
The return object of the method
Top

PUBLIC Progress.Lang.Object 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
Returns Progress.Lang.Object
The return object of the method
Top

PUBLIC Progress.Lang.Object 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
Returns Progress.Lang.Object
The return object of the method
Top

PUBLIC Progress.Lang.Object 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
Returns Progress.Lang.Object
The return object of the method
Top

PUBLIC Progress.Lang.Object 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
Returns Progress.Lang.Object
The return object of the method
Top

PUBLIC Progress.Lang.Object 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
Returns Progress.Lang.Object
The return object of the method
Top

PUBLIC Progress.Lang.Object 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
Returns Progress.Lang.Object
The return object of the method
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 InvokeTaskAsyncNoOutput (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
This variant does not return any OUTPUT parameters to the caller

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
Top

PUBLIC InvokeTaskAsyncNoOutput (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
This variant does not return any OUTPUT parameters to the caller

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
Top

PUBLIC InvokeTaskAsyncNoOutput (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
This variant does not return any OUTPUT parameters to the caller

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
Top

PUBLIC InvokeTaskAsyncNoOutput (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
This variant does not return any OUTPUT parameters to the caller

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
Top

PUBLIC InvokeTaskAsyncNoOutput (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
This variant does not return any OUTPUT parameters to the caller

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
Top

PUBLIC InvokeTaskAsyncNoOutput (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
This variant does not return any OUTPUT parameters to the caller

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
Top

PUBLIC InvokeTaskAsyncNoOutput (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
This variant does not return any OUTPUT parameters to the caller

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
Top

PUBLIC InvokeTaskAsyncNoOutput (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
This variant does not return any OUTPUT parameters to the caller

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
Top

PUBLIC InvokeTaskAsyncNoOutput (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
This variant does not return any OUTPUT parameters to the caller

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
Top

PUBLIC InvokeTaskAsyncNoOutput (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
This variant does not return any OUTPUT parameters to the caller

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
Top

PUBLIC InvokeTaskAsyncNoOutput (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
This variant does not return any OUTPUT parameters to the caller

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
Top

PUBLIC InvokeTaskAsyncNoOutput (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
This variant does not return any OUTPUT parameters to the caller

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
Top

PUBLIC OnAsyncTaskCompleted (AsyncTaskCompletedEventArgs)

Purpose: Raises the AsyncTaskCompleted
Notes: This method is public because it's invoked by the async request handler
procedure

Parameters:
e Consultingwerk.OERA.AsyncTaskCompletedEventArgs
The AsyncTaskCompletedEventArgs with the data for the event
Top

PROTECTED OnCollectContextFromServer (EventArgs)

Purpose: Raises the CollectContextFromServer
Notes:

Parameters:
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs with the data for the event
Top

PROTECTED OnExiting (EventArgs)

Purpose: Raises the Existing event
Notes:

Parameters:
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs with the data for this event
Top

PROTECTED OnPrepareContextForServer (EventArgs)

Purpose: Raises the PrepareContextForServer
Notes:

Parameters:
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs with the data for the event
Top

PUBLIC OnRetrieveDataAsyncCompleted (RetrieveDataAsyncCompletedEventArgs)

Purpose: Raises the RetrieveDataAsyncCompleted event
Notes: This method is public because it's invoked by the retrieve data
async handler

Parameters:
e Consultingwerk.OERA.RetrieveDataAsyncCompletedEventArgs
The RetrieveDataAsyncCompletedEventArgs with the data for the event
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 HANDLE RetrieveDataAsync (character, character, IFetchDataRequest, dataset-handle)

Purpose: Reads data from the Backend asynchronously
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, passed BY-REFERENCE
Returns HANDLE
The handle of the async AppServer request
Top

PUBLIC HANDLE RetrieveDataAsync (character, character, IFetchDataRequest, dataset-handle, handle)

Purpose: Reads data from the Backend asynchronously
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, passed BY-REFERENCE
phContextDataset HANDLE
The handle of the context dataset for this call
Returns HANDLE
The handle of the async AppServer request
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 or business task 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
Top

PROTECTED WriteLogMessage (character, character, character, character)

Purpose: Writes a message to the log file
Notes:

Parameters:
pcPartition CHARACTER
The name of the AppServer partition
pcServiceName CHARACTER
The name of the business entity or business task
pcMethodName CHARACTER
The name of the method in the service adapter
pcComments CHARACTER
Additional comments


Constructor Detail
Top

PUBLIC ServiceAdapter ()

Purpose: Constructor for the ServiceAdapter class
Notes:



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 Exiting (Object, EventArgs)

Purpose: Raised when Exiting due to a lost AppServer connection
Notes:

Parameters:
sender Progress.Lang.Object
The object that raised the AsyncTaskCompleted 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
Top

PUBLIC RetrieveDataAsyncCompleted (Object, RetrieveDataAsyncCompletedEventArgs)

Purpose: Raised when an async RetrieveData call has completed
Notes:

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


Property Detail
Top

PUBLIC CHARACTER AppServerPartition


Returns CHARACTER
Top

PUBLIC Consultingwerk.OERA.OptionsOnDisconnectEnum BehaviorOnDisconnect


Returns Consultingwerk.OERA.OptionsOnDisconnectEnum
Top

PUBLIC LOGICAL BlockedByReconnectDialog


Returns LOGICAL
Top

PUBLIC CHARACTER CUSTOM_LOG_ENTRY


Returns CHARACTER
Top

PUBLIC LOGICAL LoggingActive


Returns LOGICAL
Top

PUBLIC CHARACTER ServiceInterfacePath


Returns CHARACTER


©2006-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       29.06.2022 12:42:52