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

Inherits: Progress.Lang.Object

File:ContextWrapper
Purpose:Wraps access to the context dataset
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Wed Jul 20 00:18:35 CEST 2011
Notes:SCL-776: Constructor is PROTECTED, so that customers may inherit
from this class and extend it by adding addional properties to it

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
+ AddTempTable (handle) Adds a temp-table to the context dataset
+ CHARACTER GetCharacterContextProperty (character) Get's a {1} property from the eContextProperties table
+ DATE GetDateContextProperty (character) Get's a {1} property from the eContextProperties table
+ DATETIME GetDateTimeContextProperty (character) Get's a {1} property from the eContextProperties table
+ DECIMAL GetDecimalContextProperty (character) Get's a {1} property from the eContextProperties table
+ INT64 GetInt64ContextProperty (character) Get's a {1} property from the eContextProperties table
+ INTEGER GetIntegerContextProperty (character) Get's a {1} property from the eContextProperties table
+ LOGICAL GetLogicalContextProperty (character) Get's a {1} property from the eContextProperties table
+ LONGCHAR GetLongcharContextProperty (character) Get's a {1} property from the eContextProperties table
+ RAW GetRawContextProperty (character) Get's a {1} property from the eContextProperties table
# HANDLE GetSessionContextField (character) Returns a handle to a field of the Session Context buffer
+ RemoveContextValues (character) Removes all values from the context properties table where the property name matches the given property name pattern (MATCHES)
+ RemoveTempTable (handle) Removes a temp-table from the context dataset
+ SetCharacterContextProperty (character, character) Set's a {1} property value in the eContextProperties table
+ SetDateContextProperty (character, date) Set's a {1} property value in the eContextProperties table
+ SetDateTimeContextProperty (character, datetime) Set's a {1} property value in the eContextProperties table
+ SetDecimalContextProperty (character, decimal) Set's a {1} property value in the eContextProperties table
+ SetInt64ContextProperty (character, int64) Set's a {1} property value in the eContextProperties table
+ SetIntegerContextProperty (character, integer) Set's a {1} property value in the eContextProperties table
+ SetLogicalContextProperty (character, logical) Set's a {1} property value in the eContextProperties table
+ SetLongcharContextProperty (character, longchar) Set's a {1} property value in the eContextProperties table
+ SetRawContextProperty (character, raw) Set's a {1} property value in the eContextProperties table

Top Constructor Summary
Options Name Purpose
# ContextWrapper () Constructor for the ContextWrapper class

Top Property Summary
Options Name Purpose
+ CHARACTER AppServerProVersion Wrapps access to eSessionContext.{1}
+ CHARACTER AppServerType Wrapps access to eSessionContext.{1}
+ RAW ClientPrincipal Wrapps access to eSessionContext.{1}
+ CHARACTER ClientProVersion Wrapps access to eSessionContext.{1}
+ CHARACTER ClientType Wrapps access to eSessionContext.{1}
+ CHARACTER LanguageDisplayName Wrapps access to eSessionContext.{1}
+ CHARACTER LanguageIsoCode Wrapps access to eSessionContext.{1}
+ CHARACTER LanguageKey Wrapps access to eSessionContext.{1}
+ CHARACTER LoginCompanyKey Wrapps access to eSessionContext.{1}
+ CHARACTER LoginCompanyName Wrapps access to eSessionContext.{1}
+ CHARACTER LoginCompanyReferenceChar Wrapps access to eSessionContext.{1}
+ DECIMAL LoginCompanyReferenceDecimal Wrapps access to eSessionContext.{1}
+ INTEGER LoginCompanyReferenceInteger Wrapps access to eSessionContext.{1}
+ CHARACTER LoginCompanyShortName Wrapps access to eSessionContext.{1}
+ CHARACTER ServerCustomLogEntries Wrapps access to eSessionContext.{1}
+ LOGICAL ServerDebugMode Wrapps access to eSessionContext.{1}
+ CHARACTER ServerLogEntryTypes Wrapps access to eSessionContext.{1}
+ CHARACTER UserGroupKeys Wrapps access to eSessionContext.{1}
+ CHARACTER UserGroupNames Wrapps access to eSessionContext.{1}
+ CHARACTER UserKey Wrapps access to eSessionContext.{1}
+ CHARACTER UserName Wrapps access to eSessionContext.{1}


Method Detail
Top

PUBLIC AddTempTable (handle)
Purpose: Adds a temp-table to the context dataset
Notes: When the context-dataset is static, we will create a new dynamic
ProDataset and use that as the new context dataset. This new context
dataset will be built using new buffers on the temp-tables of the
previous (static) context dataset
When the temp-tables default-buffer-handle is already member of a
ProDataset we will create a new dynamic buffer for the table and
add that to the dataset

Parameters:
phTempTable HANDLE
The handle of the Temp-Table to add to the context dataset
Top

PUBLIC CHARACTER GetCharacterContextProperty (character)
Purpose: Get's a {1} property from the eContextProperties table
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the property
Returns CHARACTER
The property value
Top

PUBLIC DATE GetDateContextProperty (character)
Purpose: Get's a {1} property from the eContextProperties table
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the property
Returns DATE
The property value
Top

PUBLIC DATETIME GetDateTimeContextProperty (character)
Purpose: Get's a {1} property from the eContextProperties table
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the property
Returns DATETIME
The property value
Top

PUBLIC DECIMAL GetDecimalContextProperty (character)
Purpose: Get's a {1} property from the eContextProperties table
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the property
Returns DECIMAL
The property value
Top

PUBLIC INT64 GetInt64ContextProperty (character)
Purpose: Get's a {1} property from the eContextProperties table
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the property
Returns INT64
The property value
Top

PUBLIC INTEGER GetIntegerContextProperty (character)
Purpose: Get's a {1} property from the eContextProperties table
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the property
Returns INTEGER
The property value
Top

PUBLIC LOGICAL GetLogicalContextProperty (character)
Purpose: Get's a {1} property from the eContextProperties table
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the property
Returns LOGICAL
The property value
Top

PUBLIC LONGCHAR GetLongcharContextProperty (character)
Purpose: Get's a {1} property from the eContextProperties table
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the property
Returns LONGCHAR
The property value
Top

PUBLIC RAW GetRawContextProperty (character)
Purpose: Get's a {1} property from the eContextProperties table
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the property
Returns RAW
The property value
Top

PROTECTED HANDLE GetSessionContextField (character)
Purpose: Returns a handle to a field of the Session Context buffer
Notes:

Parameters:
pcFieldName CHARACTER
The name of the context buffer field
Returns HANDLE
The handle of the conext buffer field
Top

PUBLIC RemoveContextValues (character)
Purpose: Removes all values from the context properties table where the
property name matches the given property name pattern (MATCHES)
Notes:

Parameters:
pcProperties CHARACTER
The pattern (MATCHES) for the property names to delete
Top

PUBLIC RemoveTempTable (handle)
Purpose: Removes a temp-table from the context dataset
Notes: When the context-dataset is static, we will throw an error as we expect
that the "core" temp-tables of a static ProDataset should not be removed.
As dynamic ProDatasets do not support removing temp-tables we are creating
a new session dataset from new buffers for the temp-tables of the buffers
that are in the current context dataset.

Parameters:
phTempTable HANDLE
The handle of the Temp-Table to remove from the context dataset
Top

PUBLIC SetCharacterContextProperty (character, character)
Purpose: Set's a {1} property value in the eContextProperties table
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the property
pxPropertyValue CHARACTER
The value of the property
Top

PUBLIC SetDateContextProperty (character, date)
Purpose: Set's a {1} property value in the eContextProperties table
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the property
pxPropertyValue DATE
The value of the property
Top

PUBLIC SetDateTimeContextProperty (character, datetime)
Purpose: Set's a {1} property value in the eContextProperties table
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the property
pxPropertyValue DATETIME
The value of the property
Top

PUBLIC SetDecimalContextProperty (character, decimal)
Purpose: Set's a {1} property value in the eContextProperties table
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the property
pxPropertyValue DECIMAL
The value of the property
Top

PUBLIC SetInt64ContextProperty (character, int64)
Purpose: Set's a {1} property value in the eContextProperties table
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the property
pxPropertyValue INT64
The value of the property
Top

PUBLIC SetIntegerContextProperty (character, integer)
Purpose: Set's a {1} property value in the eContextProperties table
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the property
pxPropertyValue INTEGER
The value of the property
Top

PUBLIC SetLogicalContextProperty (character, logical)
Purpose: Set's a {1} property value in the eContextProperties table
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the property
pxPropertyValue LOGICAL
The value of the property
Top

PUBLIC SetLongcharContextProperty (character, longchar)
Purpose: Set's a {1} property value in the eContextProperties table
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the property
pxPropertyValue LONGCHAR
The value of the property
Top

PUBLIC SetRawContextProperty (character, raw)
Purpose: Set's a {1} property value in the eContextProperties table
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the property
pxPropertyValue RAW
The value of the property


Constructor Detail
Top

PROTECTED ContextWrapper ()
Purpose: Constructor for the ContextWrapper class
Notes: Disallow instance creation
SCL-776: Constructor is PROTECTED, so that customers may inherit
from this class and extend it by adding addional properties to it



Property Detail
Top

PUBLIC CHARACTER AppServerProVersion
Purpose: Wrapps access to eSessionContext.{1}
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER AppServerType
Purpose: Wrapps access to eSessionContext.{1}
Notes:

Returns CHARACTER
Top

PUBLIC RAW ClientPrincipal
Purpose: Wrapps access to eSessionContext.{1}
Notes:

Returns RAW
Top

PUBLIC CHARACTER ClientProVersion
Purpose: Wrapps access to eSessionContext.{1}
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER ClientType
Purpose: Wrapps access to eSessionContext.{1}
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER LanguageDisplayName
Purpose: Wrapps access to eSessionContext.{1}
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER LanguageIsoCode
Purpose: Wrapps access to eSessionContext.{1}
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER LanguageKey
Purpose: Wrapps access to eSessionContext.{1}
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER LoginCompanyKey
Purpose: Wrapps access to eSessionContext.{1}
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER LoginCompanyName
Purpose: Wrapps access to eSessionContext.{1}
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER LoginCompanyReferenceChar
Purpose: Wrapps access to eSessionContext.{1}
Notes:

Returns CHARACTER
Top

PUBLIC DECIMAL LoginCompanyReferenceDecimal
Purpose: Wrapps access to eSessionContext.{1}
Notes:

Returns DECIMAL
Top

PUBLIC INTEGER LoginCompanyReferenceInteger
Purpose: Wrapps access to eSessionContext.{1}
Notes:

Returns INTEGER
Top

PUBLIC CHARACTER LoginCompanyShortName
Purpose: Wrapps access to eSessionContext.{1}
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER ServerCustomLogEntries
Purpose: Wrapps access to eSessionContext.{1}
Notes:

Returns CHARACTER
Top

PUBLIC LOGICAL ServerDebugMode
Purpose: Wrapps access to eSessionContext.{1}
Notes:

Returns LOGICAL
Top

PUBLIC CHARACTER ServerLogEntryTypes
Purpose: Wrapps access to eSessionContext.{1}
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER UserGroupKeys
Purpose: Wrapps access to eSessionContext.{1}
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER UserGroupNames
Purpose: Wrapps access to eSessionContext.{1}
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER UserKey
Purpose: Wrapps access to eSessionContext.{1}
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER UserName
Purpose: Wrapps access to eSessionContext.{1}
Notes:

Returns CHARACTER


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