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

File:IServiceAdapterWithContextDataset
Purpose:Interface to be implemented by ServiceAdapter implementations
that support a custom context dataset
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sat Jul 16 11:57:41 CEST 2011
Notes:This interface is no longer required to use. As of SCL-1045
the basic IServiceAdapter interface was enhanced to contain
all ServiceAdapter functionality. As such, all methods of
the ServiceAdapter class are directly accessible from the
FrameworkSettings:ServiceAdapter reference withour the
previous need to case to this interface.
Purpose: Raised when an async RetrieveData call has completed
Notes:

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
+ FetchDataset (character, character, dataset-handle, handle) Returns an Empty Dataset (schema) to the client.
+ Progress.Lang.Object InvokeMethod (character, character, character, dataset-handle, ISerializable, handle) Invokes a custom method of the BusinessEntity.
+ RetrieveData (character, character, IFetchDataRequest, dataset-handle, handle) Reads data from the Backend
+ HANDLE RetrieveDataAsync (character, character, IFetchDataRequest, dataset-handle, handle) Reads data from the Backend asynchronously
+ SubmitData (character, character, dataset-handle, character, handle) Saves modified (Create, Update, Delete) data to a Business Entity

Top Event Summary
Options Name Purpose
+ RetrieveDataAsyncCompleted (Object, RetrieveDataAsyncCompletedEventArgs) Raised when an async RetrieveData call has completed


Method Detail
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 Progress.Lang.Object InvokeMethod (character, character, character, dataset-handle, ISerializable, handle)
Purpose: Invokes a custom method of the BusinessEntity.
Notes:

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
Returns Progress.Lang.Object
The parameter object. May be updated/different from the input object
Top

PUBLIC RetrieveData (character, character, IFetchDataRequest, dataset-handle, 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
phContextDataset HANDLE
The handle of the context dataset for this call
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
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, 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

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


Event Detail
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


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       08.12.2024 13:00:07