Namespace: OpenEdge.Web.DataObject.Writer
Class
DefaultArgumentValueWriterBuilder
Parent classes:
Inherits: OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder

Copyright (c) 2016-2018 by Progress Software Corporation. All rights reserved.
File:DefaultArgumentValueWriterBuilder
Purpose:The default implementation of a ArgumentValueWriterBuilder
Author(s):pjudge
Created:2016-06-08
Notes:* Uses the ArgumentValueWriterRegistry to find an appropriate
implementation
Purpose: Each concrete builder will implement this differently




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 */
Inherited from OpenEdge.Core.Util.ConfigBuilder
OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder Build (OperationArgument) /** Returns an argument value writer for a argument @param OperationArgument The operation for which to build the writer @return ArgumentValueWriterBuilder The entity writer builder to use */
Inherited from OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder Build (Class) /** Returns an argument value writer for a argument type. @param P.L.Class The argument type for which to build the writer @return ArgumentValueWriterBuilder The entity writer builder to use */
Inherited from OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder Build (Class, BuilderRegistry) /** Returns an argument value writer for a argument type @param P.L.Class The argument type for which to build the writer @param BuilderRegistry The registry from which to find the writer @return ArgumentValueWriterBuilder The entity writer builder to use */
Inherited from OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
ClearOptions () /** Clears all options for this builder */
Inherited from OpenEdge.Core.Util.ConfigBuilder
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. */
Inherited from OpenEdge.Core.Util.ConfigBuilder
OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder FromRegistry (BuilderRegistry) /** Adds a custom/service-level registry for ArgumentValueWriters @param BuilderRegistry The registry @return ArgumentValueWriterBuilder This builder object. */
Inherited from OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
DATETIME-TZ GetOptionDateTimeValue (character) /** Returns an option's datetime value @param character The option name @return datetime-tz the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL GetOptionLogicalValue (character) /** Returns an option's logical value @param character The option name @return logical the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LONGCHAR GetOptionLongcharValue (character) /** Returns an option's longchar value @param character The option name @return longchar the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
DECIMAL GetOptionNumericValue (character) /** Returns an option's decimal value @param character The option name @return decimal the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
Object GetOptionObjectValue (character) /** Returns an option's object value @param character The option name @return Object the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
CHARACTER GetOptionStringArrayValue (character) /** Returns an option's character array value @param character The option name @return character[] the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
CHARACTER GetOptionStringValue (character) /** Returns an option's character value @param character The option name @return character the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
Progress.Lang.Class GetWriter (Class, BuilderRegistry) /** Returns a value writer from a particular registry The search alogrithm is 0. Empty registry returns nothing 1. Equality match - identical type name 2. IsA / Inherits match. This may be slow, so if one is found, it's registered @param Progress.Lang.Class The current argument type for which we are trying to find a writer @param BuilderRegistry The registry in which to look @return Progress.Lang.Class The type of the writer. It's the caller's responsibility to invoke and use the writer */
Inherited from OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
LOGICAL HasOption (character) /** Checks whether a config option already exists @param character The option name @return logical True if the named configuration option exists */
Inherited from OpenEdge.Core.Util.ConfigBuilder
OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder Logger (ILogWriter) /** Adds or overwrites an option for the client library. @param character The name of the option @param character The value of the option (can be anything) @return ArgumentValueWriterBuilder This builder object. */
Inherited from OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
OpenEdge.Web.DataObject.Writer.ArgumentValueWriter NewArgumentValueWriter () /* Instantiates a new Arg Writer for the passed-in type @return ArgumentValueWriter A new Arg Writer for the arg type */
OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder Option (character, character) /** Adds or overwrites an option for the client library. @param character The name of the option @param character The value of the option (can be anything) @return ArgumentValueWriterBuilder This builder object. */
Inherited from OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder Option (character, decimal) /** Adds or overwrites an option for the client library. @param character The name of the option @param decimal The value of the option (can be anything) @return ArgumentValueWriterBuilder This builder object. */
Inherited from OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder Option (character, int64) /** Adds or overwrites an option for the client library. @param character The name of the option @param int64 The value of the option (can be anything) @return ArgumentValueWriterBuilder This builder object. */
Inherited from OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder Option (character, logical) /** Adds or overwrites an option for the client library. @param character The name of the option @param logical The value of the option (can be anything) @return ArgumentValueWriterBuilder This builder object. */
Inherited from OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder Option (character, Object) /** Adds or overwrites an option for the client library. @param character The name of the option @param Object The value of the option (can be anything) @return ArgumentValueWriterBuilder This builder object. */
Inherited from OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
LOGICAL RemoveOption (character) /** Removes an option @param character The option name */
Inherited from OpenEdge.Core.Util.ConfigBuilder
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 */
Inherited from OpenEdge.Core.Util.ConfigBuilder
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 */
Inherited from OpenEdge.Core.Util.ConfigBuilder
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 */
Inherited from OpenEdge.Core.Util.ConfigBuilder
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 */
Inherited from OpenEdge.Core.Util.ConfigBuilder
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 */
Inherited from OpenEdge.Core.Util.ConfigBuilder
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 */
Inherited from OpenEdge.Core.Util.ConfigBuilder
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 */
Inherited from OpenEdge.Core.Util.ConfigBuilder
OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder WriteTo (Object) /** Specifies the Entity object to use for the message body @param Progress.Lang.Object The argument value into which to write @return ArgumentValueWriterBuilder The writer used */
Inherited from OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder WriteTo (Object, Class) /** Specifies the Entity object to use for the message body @param Progress.Lang.Object The argument value into which to write @param Progress.Lang.Class The type of the argument (actual type or maybe interface) @return ArgumentValueWriterBuilder The writer used */
Inherited from OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder

Constructor Summary
Options Name Purpose
DefaultArgumentValueWriterBuilder (Class) /* Constructor @param Progress.Lang.Class The argument type for this Arg Writer */

Property Summary
Options Name Purpose
Progress.Lang.Class ArgumentType
Inherited from OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
OpenEdge.Core.Util.BuilderRegistry Registry
Inherited from OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
OpenEdge.Web.DataObject.Writer.ArgumentValueWriter Writer
Overrides OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder:Writer


Method Detail
Top

PROTECTED LOGICAL AppendArrayCharacterValue (character, character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Appends a character value to an array (convenience)
Parameters:
pcName CHARACTER
pcValue CHARACTER
Returns LOGICAL
Top

PUBLIC OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder Build (OperationArgument)

Inherited from OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
Purpose: Returns an argument value writer for a argument
Parameters:
poArg OperationArgument
Returns OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
ArgumentValueWriterBuilder The entity writer builder to use
Top

PUBLIC OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder Build (Class)

Inherited from OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
Purpose: Returns an argument value writer for a argument type.
Parameters:
poArgType Progress.Lang.Class
Returns OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
ArgumentValueWriterBuilder The entity writer builder to use
Top

PUBLIC OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder Build (Class, BuilderRegistry)

Inherited from OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
Purpose: Returns an argument value writer for a argument type
Parameters:
pArgType Progress.Lang.Class
pRegistry OpenEdge.Core.Util.BuilderRegistry
Returns OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
ArgumentValueWriterBuilder The entity writer builder to use
Top

PROTECTED ClearOptions ()

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Clears all options for this builder
Top

PROTECTED LOGICAL FindConfigRecord (buffer, character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
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

PUBLIC OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder FromRegistry (BuilderRegistry)

Inherited from OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
Purpose: Adds a custom/service-level registry for ArgumentValueWriters
Parameters:
pValue OpenEdge.Core.Util.BuilderRegistry
Returns OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
ArgumentValueWriterBuilder This builder object.
Top

PROTECTED DATETIME-TZ GetOptionDateTimeValue (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Returns an option's datetime value
Parameters:
pcName CHARACTER
Returns DATETIME-TZ
datetime-tz the value
Top

PROTECTED LOGICAL GetOptionLogicalValue (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Returns an option's logical value
Parameters:
pcName CHARACTER
Returns LOGICAL
logical the value
Top

PROTECTED LONGCHAR GetOptionLongcharValue (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Returns an option's longchar value
Parameters:
pcName CHARACTER
Returns LONGCHAR
longchar the value
Top

PROTECTED DECIMAL GetOptionNumericValue (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Returns an option's decimal value
Parameters:
pcName CHARACTER
Returns DECIMAL
decimal the value
Top

PROTECTED Object GetOptionObjectValue (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Returns an option's object value
Parameters:
pcName CHARACTER
Returns Object
Object the value
Top

PROTECTED CHARACTER GetOptionStringArrayValue (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Returns an option's character array value
Parameters:
pcName CHARACTER
Returns CHARACTER
character[] the value
Top

PROTECTED CHARACTER GetOptionStringValue (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Returns an option's character value
Parameters:
pcName CHARACTER
Returns CHARACTER
character the value
Top

PROTECTED Progress.Lang.Class GetWriter (Class, BuilderRegistry)

Inherited from OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
Purpose: Returns a value writer from a particular registry
The search alogrithm is
0. Empty registry returns nothing
1. Equality match - identical type name
2. IsA / Inherits match. This may be slow, so if one is found, it's registered
Parameters:
poArgType Progress.Lang.Class
poRegistry OpenEdge.Core.Util.BuilderRegistry
Returns Progress.Lang.Class
Progress.Lang.Class The type of the writer. It's the caller's responsibility to invoke and use the writer
Top

PROTECTED LOGICAL HasOption (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Checks whether a config option already exists
Parameters:
pcConfigName CHARACTER
Returns LOGICAL
logical True if the named configuration option exists
Top

PUBLIC OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder Logger (ILogWriter)

Inherited from OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
Purpose: Adds or overwrites an option for the client library.
Parameters:
poLogger OpenEdge.Logging.ILogWriter
Returns OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
ArgumentValueWriterBuilder This builder object.
Top

PRIVATE OpenEdge.Web.DataObject.Writer.ArgumentValueWriter NewArgumentValueWriter ()

/* Instantiates a new Arg Writer for the passed-in type
Returns OpenEdge.Web.DataObject.Writer.ArgumentValueWriter
ArgumentValueWriter A new Arg Writer for the arg type
Top

PUBLIC OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder Option (character, character)

Inherited from OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
Purpose: Adds or overwrites an option for the client library.
Parameters:
pcName CHARACTER
pcValue CHARACTER
Returns OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
ArgumentValueWriterBuilder This builder object.
Top

PUBLIC OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder Option (character, decimal)

Inherited from OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
Purpose: Adds or overwrites an option for the client library.
Parameters:
pcName CHARACTER
pdValue DECIMAL
Returns OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
ArgumentValueWriterBuilder This builder object.
Top

PUBLIC OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder Option (character, int64)

Inherited from OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
Purpose: Adds or overwrites an option for the client library.
Parameters:
pcName CHARACTER
piValue INT64
Returns OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
ArgumentValueWriterBuilder This builder object.
Top

PUBLIC OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder Option (character, logical)

Inherited from OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
Purpose: Adds or overwrites an option for the client library.
Parameters:
pcName CHARACTER
plValue LOGICAL
Returns OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
ArgumentValueWriterBuilder This builder object.
Top

PUBLIC OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder Option (character, Object)

Inherited from OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
Purpose: Adds or overwrites an option for the client library.
Parameters:
pcName CHARACTER
poValue Object
Returns OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
ArgumentValueWriterBuilder This builder object.
Top

PROTECTED LOGICAL RemoveOption (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Removes an option
Parameters:
pcName CHARACTER
Returns LOGICAL
Top

PROTECTED LOGICAL SetOption (character, character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Stores an value as an option
Parameters:
pcName CHARACTER
pcValue CHARACTER
Returns LOGICAL
logical True is the option was overwritten
Top

PROTECTED LOGICAL SetOption (character, character[])

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Stores an value as an option
Parameters:
pcName CHARACTER
pcValue CHARACTER
Returns LOGICAL
logical True is the option was overwritten
Top

PROTECTED LOGICAL SetOption (character, datetime-tz)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Stores a datetime-tzvalue as an option
Parameters:
pcName CHARACTER
ptValue DATETIME-TZ
Returns LOGICAL
logical True is the option was overwritten
Top

PROTECTED LOGICAL SetOption (character, decimal)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Stores an numeric value as an option
Parameters:
pcName CHARACTER
pdValue DECIMAL
Returns LOGICAL
logical True is the option was overwritten
Top

PROTECTED LOGICAL SetOption (character, logical)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Stores a logical value as an option
Parameters:
pcName CHARACTER
plValue LOGICAL
Returns LOGICAL
logical True is the option was overwritten
Top

PROTECTED LOGICAL SetOption (character, Object)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Stores an object value as an option
Parameters:
pcName CHARACTER
poValue Object
Returns LOGICAL
logical True is the option was overwritten
Top

PROTECTED LOGICAL SetOption (Class, Object)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Stores an object value as an option
Parameters:
pName Progress.Lang.Class
pValue Object
Returns LOGICAL
logical True is the option was overwritten
Top

PUBLIC OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder WriteTo (Object)

Inherited from OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
Purpose: Specifies the Entity object to use for the message body
Parameters:
poValue Object
Returns OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
ArgumentValueWriterBuilder The writer used
Top

PUBLIC OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder WriteTo (Object, Class)

Inherited from OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
Purpose: Specifies the Entity object to use for the message body
Parameters:
pArgValue Object
pArgType Progress.Lang.Class
Returns OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
ArgumentValueWriterBuilder The writer used


Constructor Detail
Top

PUBLIC DefaultArgumentValueWriterBuilder (Class)

/* Constructor
Parameters:
poArgType Progress.Lang.Class


Property Detail
Top

PUBLIC Progress.Lang.Class ArgumentType

Inherited from OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
Returns Progress.Lang.Class
Top

PUBLIC OpenEdge.Core.Util.BuilderRegistry Registry

Inherited from OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder
Returns OpenEdge.Core.Util.BuilderRegistry
Top

PUBLIC OpenEdge.Web.DataObject.Writer.ArgumentValueWriter Writer

Overrides OpenEdge.Web.DataObject.Writer.ArgumentValueWriterBuilder:Writer
Returns OpenEdge.Web.DataObject.Writer.ArgumentValueWriter


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0