Namespace: OpenEdge.Web.DataObject.Writer
Type: Class ArgumentValueWriter
Parent Classes:
Inherits: Progress.Lang.Object
Implements: OpenEdge.Logging.ISupportLogging


/* *************************************************************************************************************************
Copyright (c) 2016-2019, 2021 by Progress Software Corporation and/or one of its subsidiaries or affiliates. All rights reserved.
File:ArgumentValueWriter
Purpose:Abstract OperationArgument:ArgumentValue writer
Author(s):pjudge
Created:2016-06-07
Notes:* The default behaviour of all the Write() methods is a NO-OP
which also writes a log message. The only exception to this
is the abstract Write(Progress.Lang.Object) method.
/* A reference to the Logger in use by an implementer



Method Summary
  Options Name Purpose
  Clear () /** Clears or empties the target */
  Close () /** Closes the writer. */
  Flush () /** Flushes(writes) the input to the target */
  Open () /** Opens the writer for output. Open/Close allows us to write the same message multiple times without requiring a new writer each time. */
  Write (character) /* no-op */
  Write (character[]) /* no-op */
  Write (date) /* no-op */
  Write (datetime) /* no-op */
  Write (datetime-tz) /* no-op */
  Write (datetime-tz[]) /* no-op */
  Write (datetime[]) /* no-op */
  Write (date[]) /* no-op */
  Write (decimal) /* no-op */
  Write (decimal[]) /* no-op */
  Write (handle) /** Write data to/from the entity @param handle Data to write */
  Write (handle[]) /* no-op */
  Write (int64) /* no-op */
  Write (int64[]) /* no-op */
  Write (integer) /* no-op */
  Write (integer[]) /* no-op */
  Write (logical) /* no-op */
  Write (logical[]) /* no-op */
  Write (longchar) /* no-op */
  Write (longchar[]) /* no-op */
  Write (memptr) /* no-op */
  Write (memptr[]) /* no-op */
  Write (Object) /** Write data to/from the entity @param Object Data to write */
  Write (Object[]) /** Write data to/from the entity @param Object[] Data to write */
  Write (raw) /* no-op */
  Write (raw[]) /* no-op */
  Write (recid) /* no-op */
  Write (recid[]) /* no-op */
  Write (rowid) /* no-op */
  Write (rowid[]) /* no-op */

Constructor Summary
  Options Name Purpose
  ArgumentValueWriter (Class) /** Constructor. @param Class The type of the entity - pseudo-generics here. */
  ArgumentValueWriter (Class, Object) /** Constructor. @param Class The type of the entity - pseudo-generics here. @param Object The 'real' entity being written */
  ArgumentValueWriter (Object) /** Constructor. @param Object The target object to write to */

Property Summary
  Options Name Purpose
  Progress.Lang.Class ArgumentType
  OpenEdge.Logging.ILogWriter Logger
  Progress.Lang.Object Value


Method Detail
Top

Clear ()

Purpose: Clears or empties the target
Top

Close ()

Purpose: Closes the writer.
Top

Flush ()

Purpose: Flushes(writes) the input to the target
Top

Open ()

Purpose: Opens the writer for output. Open/Close allows us to write the same message multiple
times without requiring a new writer each time.
Top

Write (character)

/* no-op
Parameters:
p0 CHARACTER
 
Top

Write (character[])

/* no-op
Parameters:
p0 CHARACTER
 
Top

Write (date)

/* no-op
Parameters:
p0 DATE
 
Top

Write (datetime)

/* no-op
Parameters:
p0 DATETIME
 
Top

Write (datetime-tz)

/* no-op
Parameters:
p0 DATETIME-TZ
 
Top

Write (datetime-tz[])

/* no-op
Parameters:
p0 DATETIME-TZ
 
Top

Write (datetime[])

/* no-op
Parameters:
p0 DATETIME
 
Top

Write (date[])

/* no-op
Parameters:
p0 DATE
 
Top

Write (decimal)

/* no-op
Parameters:
p0 DECIMAL
 
Top

Write (decimal[])

/* no-op
Parameters:
p0 DECIMAL
 
Top

Write (handle)

Purpose: Write data to/from the entity
Parameters:
phData HANDLE
 
Top

Write (handle[])

/* no-op
Parameters:
phData HANDLE
 
Top

Write (int64)

/* no-op
Parameters:
p0 INT64
 
Top

Write (int64[])

/* no-op
Parameters:
p0 INT64
 
Top

Write (integer)

/* no-op
Parameters:
p0 INTEGER
 
Top

Write (integer[])

/* no-op
Parameters:
p0 INTEGER
 
Top

Write (logical)

/* no-op
Parameters:
p0 LOGICAL
 
Top

Write (logical[])

/* no-op
Parameters:
p0 LOGICAL
 
Top

Write (longchar)

/* no-op
Parameters:
p0 LONGCHAR
 
Top

Write (longchar[])

/* no-op
Parameters:
p0 LONGCHAR
 
Top

Write (memptr)

/* no-op
Parameters:
p0 MEMPTR
 
Top

Write (memptr[])

/* no-op
Parameters:
p0 MEMPTR
 
Top

Write (Object)

Purpose: Write data to/from the entity
Parameters:
poData Progress.Lang.Object
 
Top

Write (Object[])

Purpose: Write data to/from the entity
Parameters:
poData Progress.Lang.Object
 
Top

Write (raw)

/* no-op
Parameters:
p0 RAW
 
Top

Write (raw[])

/* no-op
Parameters:
p0 RAW
 
Top

Write (recid)

/* no-op
Parameters:
p0 RECID
 
Top

Write (recid[])

/* no-op
Parameters:
p0 RECID
 
Top

Write (rowid)

/* no-op
Parameters:
p0 ROWID
 
Top

Write (rowid[])

/* no-op
Parameters:
p0 ROWID
 


Constructor Detail
Top

ArgumentValueWriter (Class)

Purpose: Constructor.
Parameters:
poType Progress.Lang.Class
 
Top

ArgumentValueWriter (Class, Object)

Purpose: Constructor.
Parameters:
poType Progress.Lang.Class
 
poValue Progress.Lang.Object
 
Top

ArgumentValueWriter (Object)

Purpose: Constructor.
Parameters:
pValue Progress.Lang.Object
 


Property Detail
Top

Progress.Lang.Class ArgumentType

Returns Progress.Lang.Class
 
Top

OpenEdge.Logging.ILogWriter Logger

Returns OpenEdge.Logging.ILogWriter
 
Top

Progress.Lang.Object Value

Returns Progress.Lang.Object