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

Inherits: Progress.Lang.Object

File:ContextWrapper
Purpose:Provides 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
SCL-1714: Rewritten as a Static facade to IContextWrapper
Purpose: Provides access to SessionContext.UserName
Notes:

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



Top Method Summary
Options Name Purpose
+ AddTempTable (handle) Adds a temp-table to the context dataset
+ AssignFromSessionManager () Assigns the eSessionContext temp-table from the SessionManager
+ CHARACTER GetCharacterContextProperty (character) Get's a Character property from the eContextProperties table
# Consultingwerk.OERA.IContextWrapper GetContextWrapperImpl () Returns the reference to the IServiceManager implementation
+ DATE GetDateContextProperty (character) Get's a Date property from the eContextProperties table
+ DATETIME GetDateTimeContextProperty (character) Get's a DateTime property from the eContextProperties table
+ DECIMAL GetDecimalContextProperty (character) Get's a Decimal property from the eContextProperties table
+ INT64 GetInt64ContextProperty (character) Get's an Int64 property from the eContextProperties table
+ INTEGER GetIntegerContextProperty (character) Get's an Integer property from the eContextProperties table
+ LOGICAL GetLogicalContextProperty (character) Get's a Logical property from the eContextProperties table
+ LONGCHAR GetLongcharContextProperty (character) Get's a Longchar property from the eContextProperties table
+ RAW GetRawContextProperty (character) Get's a Raw property from the eContextProperties table
+ 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 Character property value in the eContextProperties table
+ SetDateContextProperty (character, date) Set's a Date property value in the eContextProperties table
+ SetDateTimeContextProperty (character, datetime) Set's a DateTime property value in the eContextProperties table
+ SetDecimalContextProperty (character, decimal) Set's a Decimal property value in the eContextProperties table
+ SetInt64ContextProperty (character, int64) Set's an Int64 property value in the eContextProperties table
+ SetIntegerContextProperty (character, integer) Set's an Integer property value in the eContextProperties table
+ SetLogicalContextProperty (character, logical) Set's a Logical property value in the eContextProperties table
+ SetLongcharContextProperty (character, longchar) Set's a Longchar property value in the eContextProperties table
+ SetRawContextProperty (character, raw) Set's a Raw property value in the eContextProperties table

Top Constructor Summary
Options Name Purpose
# 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 */

Top Property Summary
Options Name Purpose
+ CHARACTER AppServerProVersion
+ CHARACTER AppServerType
+ RAW ClientPrincipal
+ CHARACTER ClientProVersion
+ CHARACTER ClientType
+ CHARACTER LanguageDisplayName
+ CHARACTER LanguageIsoCode
+ CHARACTER LanguageKey
+ CHARACTER LoginCompanyKey
+ CHARACTER LoginCompanyName
+ CHARACTER LoginCompanyReferenceChar
+ DECIMAL LoginCompanyReferenceDecimal
+ INTEGER LoginCompanyReferenceInteger
+ CHARACTER LoginCompanyShortName
+ DATE ProcessingDate
+ LONGCHAR RestrictedTokens
+ CHARACTER ServerCustomLogEntries
+ LOGICAL ServerDebugMode
+ CHARACTER ServerLogEntryTypes
+ CHARACTER UserEmail
+ CHARACTER UserFullName
+ CHARACTER UserGroupKeys
+ CHARACTER UserGroupNames
+ CHARACTER UserKey
+ CHARACTER UserName


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 AssignFromSessionManager ()
Purpose: Assigns the eSessionContext temp-table from the
SessionManager
Notes:

Top

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

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

PROTECTED Consultingwerk.OERA.IContextWrapper GetContextWrapperImpl ()
Purpose: Returns the reference to the IServiceManager implementation
Notes: May create the instance of the ServiceManagerImpl on first request

Returns Consultingwerk.OERA.IContextWrapper
The IServiceManagerImpl instance
Top

PUBLIC DATE GetDateContextProperty (character)
Purpose: Get's a Date 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 DateTime 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 Decimal 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 an Int64 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 an Integer 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 Logical 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 Longchar 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 Raw property from the eContextProperties table
Notes:

Parameters:
pcPropertyName CHARACTER
The name of the property
Returns RAW
The property value
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 Character property value in the eContextProperties table
Notes:

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

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

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

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

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

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

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

PUBLIC SetInt64ContextProperty (character, int64)
Purpose: Set's an Int64 property value in the eContextProperties table
Notes:

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

PUBLIC SetIntegerContextProperty (character, integer)
Purpose: Set's an Integer property value in the eContextProperties table
Notes:

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

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

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

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

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

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

Parameters:
pcPropertyName CHARACTER
The name of the property
praPropertyValue 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

Returns CHARACTER
Top

PUBLIC CHARACTER AppServerType

Returns CHARACTER
Top

PUBLIC RAW ClientPrincipal

Returns RAW
Top

PUBLIC CHARACTER ClientProVersion

Returns CHARACTER
Top

PUBLIC CHARACTER ClientType

Returns CHARACTER
Top

PUBLIC CHARACTER LanguageDisplayName

Returns CHARACTER
Top

PUBLIC CHARACTER LanguageIsoCode

Returns CHARACTER
Top

PUBLIC CHARACTER LanguageKey

Returns CHARACTER
Top

PUBLIC CHARACTER LoginCompanyKey

Returns CHARACTER
Top

PUBLIC CHARACTER LoginCompanyName

Returns CHARACTER
Top

PUBLIC CHARACTER LoginCompanyReferenceChar

Returns CHARACTER
Top

PUBLIC DECIMAL LoginCompanyReferenceDecimal

Returns DECIMAL
Top

PUBLIC INTEGER LoginCompanyReferenceInteger

Returns INTEGER
Top

PUBLIC CHARACTER LoginCompanyShortName

Returns CHARACTER
Top

PUBLIC DATE ProcessingDate

Returns DATE
Top

PUBLIC LONGCHAR RestrictedTokens

Returns LONGCHAR
Top

PUBLIC CHARACTER ServerCustomLogEntries

Returns CHARACTER
Top

PUBLIC LOGICAL ServerDebugMode

Returns LOGICAL
Top

PUBLIC CHARACTER ServerLogEntryTypes

Returns CHARACTER
Top

PUBLIC CHARACTER UserEmail

Returns CHARACTER
Top

PUBLIC CHARACTER UserFullName

Returns CHARACTER
Top

PUBLIC CHARACTER UserGroupKeys

Returns CHARACTER
Top

PUBLIC CHARACTER UserGroupNames

Returns CHARACTER
Top

PUBLIC CHARACTER UserKey

Returns CHARACTER
Top

PUBLIC CHARACTER UserName

Returns CHARACTER


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       15.04.2024 05:52:14