Namespace: OpenEdge.Core.Util
Class
ConfigBuilder
Parent classes:
Progress.Lang.Object

Inherits: Progress.Lang.Object

Copyright (c) 2015, 2018-2019 by Progress Software Corporation. All rights reserved.
File:ConfigBuilder
Purpose:helper class for configuration data used by builders
Author(s):pjudge
Created:Thu Mar 19 14:55:32 EDT 2015
/* single static tt for perf




Method Summary
Options Name Purpose
LOGICAL AppendArrayCharacterValue (character, character) /** Appends a character value to an array (convenience) @param character The option name @param character the value */
ClearOptions () /** Clears all options for this builder */
LOGICAL FindConfigRecord (buffer, character) /** Internal helper method to perform the find. This method attempts to find a record using the input buffer. @param buffer The buffer of the ConfigOption table. @param character The config name @return logical True if a config record was found. */
DATETIME-TZ GetOptionDateTimeValue (character) /** Returns an option's datetime value @param character The option name @return datetime-tz the value */
LOGICAL GetOptionLogicalValue (character) /** Returns an option's logical value @param character The option name @return logical the value */
LONGCHAR GetOptionLongcharValue (character) /** Returns an option's longchar value @param character The option name @return longchar the value */
DECIMAL GetOptionNumericValue (character) /** Returns an option's decimal value @param character The option name @return decimal the value */
Progress.Lang.Object GetOptionObjectValue (character) /** Returns an option's object value @param character The option name @return Object the value */
CHARACTER GetOptionStringArrayValue (character) /** Returns an option's character array value @param character The option name @return character[] the value */
CHARACTER GetOptionStringValue (character) /** Returns an option's character value @param character The option name @return character the value */
LOGICAL HasOption (character) /** Checks whether a config option already exists @param character The option name @return logical True if the named configuration option exists */
LOGICAL RemoveOption (character) /** Removes an option @param character The option name */
LOGICAL SetOption (character, character) /** Stores an value as an option @param character The option name @param character the value @return logical True is the option was overwritten */
LOGICAL SetOption (character, character[]) /** Stores an value as an option @param character The option name @param character the value @return logical True is the option was overwritten */
LOGICAL SetOption (character, datetime-tz) /** Stores a datetime-tzvalue as an option @param character The option name @param datetime-tz the value @return logical True is the option was overwritten */
LOGICAL SetOption (character, decimal) /** Stores an numeric value as an option @param character The option name @param Object the value @return logical True is the option was overwritten */
LOGICAL SetOption (character, logical) /** Stores a logical value as an option @param character The option name @param logical the value @return logical True is the option was overwritten */
LOGICAL SetOption (character, Object) /** Stores an object value as an option @param character The option name @param Object the value @return logical True is the option was overwritten */
LOGICAL SetOption (Class, Object) /** Stores an object value as an option @param Progress.Lang>Class The option name (as a type) @param Object the value @return logical True is the option was overwritten */


Method Detail
Top

LOGICAL AppendArrayCharacterValue (character, character)

Purpose: Appends a character value to an array (convenience)
Parameters:
pcName CHARACTER
pcValue CHARACTER
Returns LOGICAL
Top

ClearOptions ()

Purpose: Clears all options for this builder
Top

LOGICAL FindConfigRecord (buffer, character)

Purpose: Internal helper method to perform the find. This method attempts to find a record using
the input buffer.
Parameters:
pConfig buffer
pName CHARACTER
Returns LOGICAL
logical True if a config record was found.
Top

DATETIME-TZ GetOptionDateTimeValue (character)

Purpose: Returns an option's datetime value
Parameters:
pcName CHARACTER
Returns DATETIME-TZ
datetime-tz the value
Top

LOGICAL GetOptionLogicalValue (character)

Purpose: Returns an option's logical value
Parameters:
pcName CHARACTER
Returns LOGICAL
logical the value
Top

LONGCHAR GetOptionLongcharValue (character)

Purpose: Returns an option's longchar value
Parameters:
pcName CHARACTER
Returns LONGCHAR
longchar the value
Top

DECIMAL GetOptionNumericValue (character)

Purpose: Returns an option's decimal value
Parameters:
pcName CHARACTER
Returns DECIMAL
decimal the value
Top

Progress.Lang.Object GetOptionObjectValue (character)

Purpose: Returns an option's object value
Parameters:
pcName CHARACTER
Returns Progress.Lang.Object
Object the value
Top

CHARACTER GetOptionStringArrayValue (character)

Purpose: Returns an option's character array value
Parameters:
pcName CHARACTER
Returns CHARACTER
character[] the value
Top

CHARACTER GetOptionStringValue (character)

Purpose: Returns an option's character value
Parameters:
pcName CHARACTER
Returns CHARACTER
character the value
Top

LOGICAL HasOption (character)

Purpose: Checks whether a config option already exists
Parameters:
pcConfigName CHARACTER
Returns LOGICAL
logical True if the named configuration option exists
Top

LOGICAL RemoveOption (character)

Purpose: Removes an option
Parameters:
pcName CHARACTER
Returns LOGICAL
Top

LOGICAL SetOption (character, character)

Purpose: Stores an value as an option
Parameters:
pcName CHARACTER
pcValue CHARACTER
Returns LOGICAL
logical True is the option was overwritten
Top

LOGICAL SetOption (character, character[])

Purpose: Stores an value as an option
Parameters:
pcName CHARACTER
pcValue CHARACTER
Returns LOGICAL
logical True is the option was overwritten
Top

LOGICAL SetOption (character, datetime-tz)

Purpose: Stores a datetime-tzvalue as an option
Parameters:
pcName CHARACTER
ptValue DATETIME-TZ
Returns LOGICAL
logical True is the option was overwritten
Top

LOGICAL SetOption (character, decimal)

Purpose: Stores an numeric value as an option
Parameters:
pcName CHARACTER
pdValue DECIMAL
Returns LOGICAL
logical True is the option was overwritten
Top

LOGICAL SetOption (character, logical)

Purpose: Stores a logical value as an option
Parameters:
pcName CHARACTER
plValue LOGICAL
Returns LOGICAL
logical True is the option was overwritten
Top

LOGICAL SetOption (character, Object)

Purpose: Stores an object value as an option
Parameters:
pcName CHARACTER
poValue Progress.Lang.Object
Returns LOGICAL
logical True is the option was overwritten
Top

LOGICAL SetOption (Class, Object)

Purpose: Stores an object value as an option
Parameters:
pName Progress.Lang.Class
pValue Progress.Lang.Object
Returns LOGICAL
logical True is the option was overwritten


Copyright © 2022 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 11.7.15