Namespace: Consultingwerk.OERA
Class 
ServiceInterface Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.OERA.ServiceInterface

Inherits: Progress.Lang.Object


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



Top Method Summary
Options Name Purpose
Activate () Executed when we begin handling a request
LOGICAL CheckToPerformRequestAuthorization () Checks if the current request should call the RequestAuthorizationProvider
CustomLogEntriesChangedHandler (EventArgs) Event handler for the CustomLogEntriesChanged event of the LogManager
Deactivate () Executed when we finish handling a request
EndRequest () Executed when a request is complete
EvaluateRequestAuthorizationProvider () (Re-)Evaluates the current IRequestAuthorizationProvider service
FetchData (character, IFetchDataRequest, dataset-handle) Reads data from a Business Entity
FetchDataset (character, dataset-handle) Returns an Empty Dataset (schema)
Consultingwerk.OERA.IBusinessEntity GetBusinessEntity (character) Returns the reference to the Business Entity instance
InvokeMethod (character, character, dataset-handle, longchar) Invokes a custom method of the BusinessEntity.
InvokeMethod (character, character, dataset-handle, Object) Invokes a custom method of the BusinessEntity.
Progress.Lang.Object InvokeTask (character, character) Invokes a method in a Task class.
Progress.Lang.Object InvokeTask (character, character, dataset-handle, dataset-handle, dataset-handle, dataset-handle, dataset-handle, Object) Invokes a method in a Task class.
Progress.Lang.Object InvokeTask (character, character, dataset-handle, dataset-handle, dataset-handle, dataset-handle, Object) Invokes a method in a Task class.
Progress.Lang.Object InvokeTask (character, character, dataset-handle, dataset-handle, dataset-handle, Object) Invokes a method in a Task class.
Progress.Lang.Object InvokeTask (character, character, dataset-handle, dataset-handle, Object) Invokes a method in a Task class.
Progress.Lang.Object InvokeTask (character, character, dataset-handle, Object) Invokes a method in a Task class.
Progress.Lang.Object InvokeTask (character, character, integer, dataset-handle, dataset-handle, dataset-handle, dataset-handle, dataset-handle, longchar) Invokes a method in a Task class.
Progress.Lang.Object InvokeTask (character, character, integer, dataset-handle, dataset-handle, dataset-handle, dataset-handle, dataset-handle, Object) Invokes a method in a Task class.
Progress.Lang.Object InvokeTask (character, character, Object) Invokes a method in a Task class.
Progress.Lang.Object InvokeTask2 (character, character, integer, dataset-handle, dataset-handle, dataset-handle, dataset-handle, dataset-handle, longchar) Invokes a method in a Task class.
Progress.Lang.Object InvokeTask2 (character, character, integer, dataset-handle, dataset-handle, dataset-handle, dataset-handle, dataset-handle, Object) Invokes a method in a Task class.
Progress.Lang.Object InvokeTaskReturnArray (character, character) Invokes a method in a Task class.
Progress.Lang.Object InvokeTaskReturnArray (character, character, dataset-handle, dataset-handle, dataset-handle, dataset-handle, dataset-handle, Object) Invokes a method in a Task class.
Progress.Lang.Object InvokeTaskReturnArray (character, character, dataset-handle, dataset-handle, dataset-handle, dataset-handle, Object) Invokes a method in a Task class.
Progress.Lang.Object InvokeTaskReturnArray (character, character, dataset-handle, dataset-handle, dataset-handle, Object) Invokes a method in a Task class.
Progress.Lang.Object InvokeTaskReturnArray (character, character, dataset-handle, dataset-handle, Object) Invokes a method in a Task class.
Progress.Lang.Object InvokeTaskReturnArray (character, character, dataset-handle, Object) Invokes a method in a Task class.
Progress.Lang.Object InvokeTaskReturnArray (character, character, Object) Invokes a method in a Task class.
OnActivated (EventArgs) Raises the Activated event
OnAfterActivated (EventArgs) Raises the AfterActivated event
OnAfterDeactivated (EventArgs) Raises the AfterDeactivated event
OnBeforeDeactivated (EventArgs) Raises the BeforeDeactivated event
OnDeactivated (EventArgs) Raises the Deactivated event
OnRequestEnded (EventArgs) Raises the RequestEnded event
OnSessionCreated (EventArgs) Raises the SessionCreated event
RaiseSessionCreatedEvent () Raises the SessionCreated event
SaveChanges (character, dataset-handle) Saves modified (Create, Update, Delete) data to a Business Entity
SaveChanges (character, dataset-handle, Object) Saves modified (Create, Update, Delete) data to a Business Entity
StopBusinessEntity (character) Stops an Business Entity Instance
LOGICAL ValidateBusinessEntityName (character) Validates a Business Entity or Business Task Name

Top Constructor Summary
Options Name Purpose
ServiceInterface () Static constructor of the ServiceInterface class

Top Event Summary
Options Name Purpose
Activated (EventArgs) Raised when the Service Interface begins handling a request
AfterActivated (EventArgs) Raised when the Service Interface begins handling a request
AfterDeactivated (EventArgs) Raised when the Service Interface is finished handling a request
BeforeDeactivated (EventArgs) Raised when the Service Interface is finished handling a request
Deactivated (EventArgs) Raised when the Service Interface is finished handling a request
RequestEnded (EventArgs) Raised when the Service Interface completes a request
SessionCreated (EventArgs) Raised when the RestServerSessionActivate has created a new session

Top Property Summary
Options Name Purpose
CHARACTER CUSTOM_LOG_ENTRY
LOGICAL IsActive
Consultingwerk.OERA.Enum.ServiceInterfaceLoggingLevelEnum LoggingLevel
CHARACTER LoggingLevelAsCharacter
LOGICAL PerformNestedRequestAuthorization


Method Detail
Top

Activate ()
Purpose: Executed when we begin handling a request
Notes: This method is PUBLIC to allow PASOE WebHandlers and REST Service
classes to activate the session prior to calling into the service
interface. This is important to allow the RestServerSessionActivator
(or similar activate handlers) to instantiate the Context Dataset
(from the Context Dataset Store) prior to calling into the
Service Interface

Top

LOGICAL CheckToPerformRequestAuthorization ()
Purpose: Checks if the current request should call the
RequestAuthorizationProvider
Notes:

Returns LOGICAL
Logical value indicating if the request should call the RequestAuthorizationProvider
Top

CustomLogEntriesChangedHandler (EventArgs)
Purpose: Event handler for the CustomLogEntriesChanged event of the LogManager
Notes:

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

Deactivate ()
Purpose: Executed when we finish handling a request
Notes: See notes of the Activate() method

Top

EndRequest ()
Purpose: Executed when a request is complete
Notes: This method should only be called from an AppServer deactivate procedure

Top

EvaluateRequestAuthorizationProvider ()
Purpose: (Re-)Evaluates the current IRequestAuthorizationProvider service
Notes:

Top

FetchData (character, IFetchDataRequest, dataset-handle)
Purpose: Reads data from a Business Entity
Notes: Request Parameters are send using the IFetchDataRequest object
Server-side code calling directly into the Service Interface is _NOT_
supposed to call this method "BY-REFERENCE" as this is the place where
the caller receives a copy of the Business Entities ProDataset

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
poFetchDataRequest Consultingwerk.OERA.IFetchDataRequest
The IFetchDataRequest instance with the data for this call
phDataset DATASET-HANDLE
OUTPUT DATASET-HANDLE The dataset with the result set - do not pass BY-REFERENCE
Top

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

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
phDataset DATASET-HANDLE
OUTPUT DATASET-HANDLE The empty dataset
Top

Consultingwerk.OERA.IBusinessEntity GetBusinessEntity (character)
Purpose: Returns the reference to the Business Entity instance
Notes: Facade to Consultingwerk.OERA.ServiceManager:GetBusinessEntity
(pcEntityName)

Parameters:
pcEntityName CHARACTER
The name of the Business Entity to return
Returns Consultingwerk.OERA.IBusinessEntity
The reference to the Business Entity
Top

InvokeMethod (character, character, dataset-handle, longchar)
Purpose: Invokes a custom method of the BusinessEntity.
Notes:

Parameters:
pcEntityName CHARACTER
The name of the Business Entity class
pcMethodName CHARACTER
The name of the method of the task to execute
phDataset DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The dataset-handle parameter to the task method
plcParameter LONGCHAR
The LONGCHAR representation of the serialized parameter object
Top

InvokeMethod (character, character, dataset-handle, Object)
Purpose: Invokes a custom method of the BusinessEntity.
Notes:

Parameters:
pcEntityName CHARACTER
The name of the Business Entity class
pcMethodName CHARACTER
The name of the method of the task to execute
phDataset DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The dataset-handle parameter to the task method
poParameter Progress.Lang.Object
The parameter object
Top

Progress.Lang.Object InvokeTask (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:
pcTaskName CHARACTER
The name of the task class
pcMethodName CHARACTER
The name of the business entity method to invoke
Returns Progress.Lang.Object
The optional return value object of the Business Task Method
Top

Progress.Lang.Object InvokeTask (character, character, dataset-handle, dataset-handle, dataset-handle, dataset-handle, dataset-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:
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 Progress.Lang.Object
The parameter object to the method
Returns Progress.Lang.Object
The optional return value object of the Business Task Method
Top

Progress.Lang.Object InvokeTask (character, character, dataset-handle, dataset-handle, dataset-handle, dataset-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:
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 Progress.Lang.Object
The parameter object to the method
Returns Progress.Lang.Object
The optional return value object of the Business Task Method
Top

Progress.Lang.Object InvokeTask (character, character, dataset-handle, dataset-handle, dataset-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:
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 Progress.Lang.Object
The parameter object to the method
Returns Progress.Lang.Object
The optional return value object of the Business Task Method
Top

Progress.Lang.Object InvokeTask (character, character, dataset-handle, dataset-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:
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 Progress.Lang.Object
The parameter object to the method
Returns Progress.Lang.Object
The optional return value object of the Business Task Method
Top

Progress.Lang.Object InvokeTask (character, character, dataset-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:
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 Progress.Lang.Object
The parameter object to the method
Returns Progress.Lang.Object
The optional return value object of the Business Task Method
Top

Progress.Lang.Object InvokeTask (character, character, integer, dataset-handle, dataset-handle, dataset-handle, dataset-handle, dataset-handle, longchar)
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:
pcTaskName CHARACTER
The name of the task class
pcMethodName CHARACTER
The name of the method of the task to execute
piNumDatasets INTEGER
The number of datasets that were passed in from the consumer
phDataset1 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The first dataset-handle parameter to the task method
phDataset2 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The second dataset-handle parameter to the task method
phDataset3 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The third dataset-handle parameter to the task method
phDataset4 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The fourth dataset-handle parameter to the task method
phDataset5 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The fifth dataset-handle parameter to the task method
plcParameter LONGCHAR
The LONGCHAR representation of the serialized parameter object
Returns Progress.Lang.Object
The optional return value object of the Business Task Method
Top

Progress.Lang.Object InvokeTask (character, character, integer, dataset-handle, dataset-handle, dataset-handle, dataset-handle, dataset-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
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:
pcTaskName CHARACTER
The name of the task class
pcMethodName CHARACTER
The name of the method of the task to execute
piNumDatasets INTEGER
The number of datasets that were passed in from the consumer
phDataset1 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The first dataset-handle parameter to the task method
phDataset2 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The second dataset-handle parameter to the task method
phDataset3 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The third dataset-handle parameter to the task method
phDataset4 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The fourth dataset-handle parameter to the task method
phDataset5 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The fifth dataset-handle parameter to the task method
poParameter Progress.Lang.Object
The parameter object
Returns Progress.Lang.Object
The optional return value object of the Business Task Method
Top

Progress.Lang.Object InvokeTask (character, character, 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:
pcTaskName CHARACTER
The name of the task class
pcMethodName CHARACTER
The name of the business entity method to invoke
poParameter Progress.Lang.Object
The parameter object to the method
Returns Progress.Lang.Object
The optional return value object of the Business Task Method
Top

Progress.Lang.Object InvokeTask2 (character, character, integer, dataset-handle, dataset-handle, dataset-handle, dataset-handle, dataset-handle, longchar)
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:
pcTaskName CHARACTER
The name of the task class
pcMethodName CHARACTER
The name of the method of the task to execute
piNumDatasets INTEGER
The number of datasets that were passed in from the consumer
phDataset1 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The first dataset-handle parameter to the task method
phDataset2 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The second dataset-handle parameter to the task method
phDataset3 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The third dataset-handle parameter to the task method
phDataset4 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The fourth dataset-handle parameter to the task method
phDataset5 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The fifth dataset-handle parameter to the task method
plcParameter LONGCHAR
The LONGCHAR representation of the serialized parameter object
Returns Progress.Lang.Object
The optional return value object of the Business Task Method
Top

Progress.Lang.Object InvokeTask2 (character, character, integer, dataset-handle, dataset-handle, dataset-handle, dataset-handle, dataset-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
object, then the parameter object is returned.

Parameters:
pcTaskName CHARACTER
The name of the task class
pcMethodName CHARACTER
The name of the method of the task to execute
piNumDatasets INTEGER
The number of datasets that were passed in from the consumer
phDataset1 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The first dataset-handle parameter to the task method
phDataset2 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The second dataset-handle parameter to the task method
phDataset3 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The third dataset-handle parameter to the task method
phDataset4 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The fourth dataset-handle parameter to the task method
phDataset5 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The fifth dataset-handle parameter to the task method
poParameter Progress.Lang.Object
The parameter object
Returns Progress.Lang.Object
The optional return value object of the Business Task Method. If the task method does not return an
Top

Progress.Lang.Object InvokeTaskReturnArray (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
This method always returns an array, even if the invoked method returns a single value
object, then the parameter object is returned as an array of size 1.

Parameters:
pcTaskName CHARACTER
The name of the task class
pcMethodName CHARACTER
The name of the method of the task to execute
Returns Progress.Lang.Object
The optional return value object as an array of the Business Task Method. If the task method does not return an
Top

Progress.Lang.Object InvokeTaskReturnArray (character, character, dataset-handle, dataset-handle, dataset-handle, dataset-handle, dataset-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 method always returns an array, even if the invoked method returns a single value
object, then the parameter object is returned as an array of size 1.

Parameters:
pcTaskName CHARACTER
The name of the task class
pcMethodName CHARACTER
The name of the method of the task to execute
phDataset1 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The first dataset-handle parameter to the task method
phDataset2 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The second dataset-handle parameter to the task method
phDataset3 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The third dataset-handle parameter to the task method
phDataset4 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The fourth dataset-handle parameter to the task method
phDataset5 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The fifth dataset-handle parameter to the task method
poParameter Progress.Lang.Object
The parameter object
Returns Progress.Lang.Object
The optional return value object as an array of the Business Task Method. If the task method does not return an
Top

Progress.Lang.Object InvokeTaskReturnArray (character, character, dataset-handle, dataset-handle, dataset-handle, dataset-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 method always returns an array, even if the invoked method returns a single value
object, then the parameter object is returned as an array of size 1.

Parameters:
pcTaskName CHARACTER
The name of the task class
pcMethodName CHARACTER
The name of the method of the task to execute
phDataset1 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The first dataset-handle parameter to the task method
phDataset2 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The second dataset-handle parameter to the task method
phDataset3 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The third dataset-handle parameter to the task method
phDataset4 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The fourth dataset-handle parameter to the task method
poParameter Progress.Lang.Object
The parameter object
Returns Progress.Lang.Object
The optional return value object as an array of the Business Task Method. If the task method does not return an
Top

Progress.Lang.Object InvokeTaskReturnArray (character, character, dataset-handle, dataset-handle, dataset-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 method always returns an array, even if the invoked method returns a single value
object, then the parameter object is returned as an array of size 1.

Parameters:
pcTaskName CHARACTER
The name of the task class
pcMethodName CHARACTER
The name of the method of the task to execute
phDataset1 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The first dataset-handle parameter to the task method
phDataset2 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The second dataset-handle parameter to the task method
phDataset3 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The third dataset-handle parameter to the task method
poParameter Progress.Lang.Object
The parameter object
Returns Progress.Lang.Object
The optional return value object as an array of the Business Task Method. If the task method does not return an
Top

Progress.Lang.Object InvokeTaskReturnArray (character, character, dataset-handle, dataset-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 method always returns an array, even if the invoked method returns a single value
object, then the parameter object is returned as an array of size 1.

Parameters:
pcTaskName CHARACTER
The name of the task class
pcMethodName CHARACTER
The name of the method of the task to execute
phDataset1 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The first dataset-handle parameter to the task method
phDataset2 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The second dataset-handle parameter to the task method
poParameter Progress.Lang.Object
The parameter object
Returns Progress.Lang.Object
The optional return value object as an array of the Business Task Method. If the task method does not return an
Top

Progress.Lang.Object InvokeTaskReturnArray (character, character, dataset-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 method always returns an array, even if the invoked method returns a single value
object, then the parameter object is returned as an array of size 1.

Parameters:
pcTaskName CHARACTER
The name of the task class
pcMethodName CHARACTER
The name of the method of the task to execute
phDataset1 DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The first dataset-handle parameter to the task method
poParameter Progress.Lang.Object
The parameter object
Returns Progress.Lang.Object
The optional return value object as an array of the Business Task Method. If the task method does not return an
Top

Progress.Lang.Object InvokeTaskReturnArray (character, character, 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 method always returns an array, even if the invoked method returns a single value
object, then the parameter object is returned as an array of size 1.

Parameters:
pcTaskName CHARACTER
The name of the task class
pcMethodName CHARACTER
The name of the method of the task to execute
poParameter Progress.Lang.Object
The parameter object
Returns Progress.Lang.Object
The optional return value object as an array of the Business Task Method. If the task method does not return an
Top

OnActivated (EventArgs)
Purpose: Raises the Activated event
Notes:

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

OnAfterActivated (EventArgs)
Purpose: Raises the AfterActivated event
Notes:

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

OnAfterDeactivated (EventArgs)
Purpose: Raises the AfterDeactivated event
Notes:

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

OnBeforeDeactivated (EventArgs)
Purpose: Raises the BeforeDeactivated event
Notes:

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

OnDeactivated (EventArgs)
Purpose: Raises the Deactivated event
Notes:

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

OnRequestEnded (EventArgs)
Purpose: Raises the RequestEnded event
Notes:

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

OnSessionCreated (EventArgs)
Purpose: Raises the SessionCreated event
Notes:

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

RaiseSessionCreatedEvent ()
Purpose: Raises the SessionCreated event
Notes: Invoked from the RestServerSessionActivator to allow
to initialize session context in a customer's application
at the beginning of the first AppServer request after the
login request (Hybrid Authentication Realm)

Top

SaveChanges (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:
pcEntityName CHARACTER
The name of the Business Entity to save the modified data with
phDataset DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the dataset with the modified values
Top

SaveChanges (character, dataset-handle, Object)
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:
pcEntityName CHARACTER
The name of the Business Entity to save the modified data with
phDataset DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The handle of the dataset with the modified values
poParameter Progress.Lang.Object
The reference to the optional parameter object instance
Top

StopBusinessEntity (character)
Purpose: Stops an Business Entity Instance
Notes: Facade to Consultingwerk.OERA.ServiceManager:StopBusinessEntity
(pcEntityName)

Parameters:
pcEntityName CHARACTER
The name of the Business Entity to stop
Top

LOGICAL ValidateBusinessEntityName (character)
Purpose: Validates a Business Entity or Business Task Name
Notes:

Parameters:
pcEntityName CHARACTER
The name of the Business Entity to validate
Returns LOGICAL
Logical value indicating if the Business Entity name is valid


Constructor Detail
Top

STATIC ServiceInterface ()
Purpose: Static constructor of the ServiceInterface class
Notes:



Event Detail
Top

Activated (EventArgs)
Purpose: Raised when the Service Interface begins handling a request
Notes:

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

AfterActivated (EventArgs)
Purpose: Raised when the Service Interface begins handling a request
Notes: This event is raised after the Activated event. This event
may be used by application or framework components to initialize
for a request after the session- or context management has
initialized

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

AfterDeactivated (EventArgs)
Purpose: Raised when the Service Interface is finished handling a request
Notes: This event is raised after the Deactivated event. This event
may be used by application or framework components to reset
after a request

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

BeforeDeactivated (EventArgs)
Purpose: Raised when the Service Interface is finished handling a request
Notes: This event is raised before the Deactivated event. This event
may be used by application or framework components to reset
after a request - but before the session context is destroyed

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

Deactivated (EventArgs)
Purpose: Raised when the Service Interface is finished handling a request
Notes:

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

RequestEnded (EventArgs)
Purpose: Raised when the Service Interface completes a request
Notes: Usually raised from the deactivate event procedure

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

SessionCreated (EventArgs)
Purpose: Raised when the RestServerSessionActivate has created a new session
Notes: Hooks for customer frameworks to initialize custom session context

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


Property Detail
Top

CHARACTER CUSTOM_LOG_ENTRY

Returns CHARACTER
Top

LOGICAL IsActive

Returns LOGICAL
Top

Consultingwerk.OERA.Enum.ServiceInterfaceLoggingLevelEnum LoggingLevel

Returns Consultingwerk.OERA.Enum.ServiceInterfaceLoggingLevelEnum
Top

CHARACTER LoggingLevelAsCharacter

Returns CHARACTER
Top

LOGICAL PerformNestedRequestAuthorization

Returns LOGICAL


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       13.04.2026 10:22:46