Consultingwerk.BufferFieldName - SmartComponent Library

Namespace:

Consultingwerk

Class

BufferFieldName

Parent classes:

Progress.Lang.Object

Consultingwerk.XmlSerializable

Consultingwerk.BufferFieldName

Inherits:

Consultingwerk.XmlSerializable

Implements:

Consultingwerk.IQueryExpression, Consultingwerk.ISerializable

File:	BufferFieldName
Purpose:	A structure that can hold all possible components
	of a buffer field reference database.table.field[index]
Author(s):	Mike Fechner / Consultingwerk Ltd.
Created:	Mon Sep 10 14:09:47 CEST 2012
Notes:	This class does not perform any validation of the property
	values

Navigate to: Methods | Constructors | Events | Properties

Top Method Summary

Options	Name	Purpose
#	AddSerializableProperties (character)	Add a list of Serializable Properties to the SerializableProperties property Inherited from Consultingwerk.XmlSerializable
+	Deserialize (longchar)	Initializes the object instance based on the passed in LONGCHAR representation of the object instance Inherited from Consultingwerk.XmlSerializable
+	DeserializeFromNode (handle)	Deserializes the object instance based on the passed in X-NODEREF instance Inherited from Consultingwerk.XmlSerializable
#	DeserializeProperty (handle, character, character)	Deserializes a single property value to the current Object Inherited from Consultingwerk.XmlSerializable
#	CHARACTER GetCharacterProperty (character)	Returns a value from a CHARACTER property in the property store Inherited from Consultingwerk.XmlSerializable
#	DATE GetDateProperty (character)	Returns a value from a DATE property in the property store Inherited from Consultingwerk.XmlSerializable
#	DATETIME-TZ GetDateTime-TZProperty (character)	Returns a value from a DATETIME-TZ property in the property store Inherited from Consultingwerk.XmlSerializable
#	DATETIME GetDateTimeProperty (character)	Returns a value from a DATETIME property in the property store Inherited from Consultingwerk.XmlSerializable
#	DECIMAL GetDecimalProperty (character)	Returns a value from a DECIMAL property in the property store Inherited from Consultingwerk.XmlSerializable
+	CHARACTER GetExpression ()	Returns the Expression to be used in a Query String
#	INT64 GetInt64Property (character)	Returns a value from a INTEGER property in the property store Inherited from Consultingwerk.XmlSerializable
#	INTEGER GetIntegerProperty (character)	Returns a value from a INTEGER property in the property store Inherited from Consultingwerk.XmlSerializable
#	LOGICAL GetLogicalProperty (character)	Returns a value from a INTEGER property in the property store Inherited from Consultingwerk.XmlSerializable
#	LONGCHAR GetLongCharProperty (character)	Returns a value from a LONGCHAR property in the property store Inherited from Consultingwerk.XmlSerializable
#	Progress.Lang.Object GetObjectProperty (character)	Returns a value from a Progress.Lang.Object property in the property store Inherited from Consultingwerk.XmlSerializable
#	RAW GetRawProperty (character)	Returns a value from a RAW property in the property store Inherited from Consultingwerk.XmlSerializable
#	CHARACTER PropertyType (character)	Returns the type of a property Inherited from Consultingwerk.XmlSerializable
+	LONGCHAR Serialize ()	Returns an LONGCHAR representation of the object instance Inherited from Consultingwerk.XmlSerializable
+	HANDLE Serialize (handle)	Serializes the properties of the current object instance to an existing X-NODEREF object Inherited from Consultingwerk.XmlSerializable
+	SerializeProperties (handle)	Serializes the properties of this object instance as child nodes of the given node Inherited from Consultingwerk.XmlSerializable
#	SerializeProperty (handle, character, character)	Serializes a single property value to the current parent XmlNode Inherited from Consultingwerk.XmlSerializable
#	SetCharacterProperty (character, character)	Assigns a CHARACTER property in the property store Inherited from Consultingwerk.XmlSerializable
#	SetDateProperty (character, date)	Assigns a DATE property in the property store Inherited from Consultingwerk.XmlSerializable
#	SetDateTime-TZProperty (character, datetime-tz)	Assigns a DATETIME-TZ property in the property store Inherited from Consultingwerk.XmlSerializable
#	SetDateTimeProperty (character, datetime)	Assigns a DATETIME property in the property store Inherited from Consultingwerk.XmlSerializable
#	SetDecimalProperty (character, decimal)	Assigns a DECIMAL property in the property store Inherited from Consultingwerk.XmlSerializable
#	SetInt64Property (character, int64)	Assigns a INTEGER property in the property store Inherited from Consultingwerk.XmlSerializable
#	SetIntegerProperty (character, integer)	Assigns a INTEGER property in the property store Inherited from Consultingwerk.XmlSerializable
#	SetLogicalProperty (character, logical)	Assigns a LOGICAL property in the property store Inherited from Consultingwerk.XmlSerializable
#	SetLongcharProperty (character, longchar)	Assigns a LOGICAL property in the property store Inherited from Consultingwerk.XmlSerializable
#	SetObjectProperty (character, Object)	Assigns a Progress.Lang.Object property in the property store Inherited from Consultingwerk.XmlSerializable
#	SetRawProperty (character, raw)	Assigns a RAW property in the property store Inherited from Consultingwerk.XmlSerializable
+	CHARACTER ToString ()	Returns a string that represents the current object.
+	LONGCHAR WriteXml ()	Returns an LONGCHAR representation of the object instance Inherited from Consultingwerk.XmlSerializable

Top Constructor Summary

Options	Name	Purpose
+	BufferFieldName ()	Constructor for the BufferFieldName class
+	BufferFieldName (character)	Constructor for the BufferFieldName class
+	BufferFieldName (character, character)	Constructor for the BufferFieldName class
+	BufferFieldName (character, character, character)	Constructor for the BufferFieldName class
+	BufferFieldName (character, character, character, integer)	Constructor for the BufferFieldName class
+	BufferFieldName (character, character, integer)	Constructor for the BufferFieldName class
+	BufferFieldName (handle)	Constructor for the BufferFieldName class
+	BufferFieldName (handle, character)	Constructor for the BufferFieldName class

Top Property Summary

Options	Name	Purpose
+	CHARACTER DatabaseName	Gets and sets the Database Name component
+	CHARACTER FieldName	Gets and sets the Field Name component
+	INTEGER Index	Gets and sets the Index component (0 for non EXTENT fields)
+	LOGICAL SerializeEmptyLists	Gets and sets if during serialization empty lists (properties of type Consultingwerk.Framework.Base.IEnumerable) that do not contain any elements, will be serialized Inherited from Consultingwerk.XmlSerializable
+	LOGICAL SerializeNullValues	Gets and sets if Null-Values should be serialized Inherited from Consultingwerk.XmlSerializable
+	CHARACTER TableName	Gets and sets the Table Name component
+	LOGICAL UseSerializedTypeInformation	Determines if the Serialization Routine will read and write the SerializedType attribute Inherited from Consultingwerk.XmlSerializable

Method Detail

Top

PROTECTED AddSerializableProperties (character)

Inherited from Consultingwerk.XmlSerializable

Purpose:	Add a list of Serializable Properties to the SerializableProperties property
Notes:	Required as a workaround to full reflection only. We may remove this
	method once Progress Software has implemented full reflection

Parameters:
pcSerializableProperties	CHARACTER
	A comma delimited list of serializable properties

Top

PUBLIC Deserialize (longchar)

Inherited from Consultingwerk.XmlSerializable

Purpose:	Initializes the object instance based on the passed in LONGCHAR
	representation of the object instance
Notes:

Parameters:
pcSerializedReprasentation	LONGCHAR
	The stored LONGCHAR representation of the objects data

Top

PUBLIC DeserializeFromNode (handle)

Inherited from Consultingwerk.XmlSerializable

Purpose:	Deserializes the object instance based on the passed in X-NODEREF
	instance
Notes:

Parameters:
phRootNode	HANDLE
	The root node with the properties for this object

Top

PROTECTED DeserializeProperty (handle, character, character)

Inherited from Consultingwerk.XmlSerializable

Purpose:	Deserializes a single property value to the current Object
Notes:	Allows to override the handling of individual properties during the
	XmlSerialization
Notes:

Parameters:
phPropertyNode	HANDLE
	reference to the source XML Node
pcProperty	CHARACTER
	The name of the property
pcType	CHARACTER
	The type of the property

Top

PROTECTED CHARACTER GetCharacterProperty (character)

Inherited from Consultingwerk.XmlSerializable

Purpose:	Returns a value from a CHARACTER property in the property store
Notes:

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

Top

PROTECTED DATE GetDateProperty (character)

Inherited from Consultingwerk.XmlSerializable

Purpose:	Returns a value from a DATE property in the property store
Notes:

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

Top

PROTECTED DATETIME-TZ GetDateTime-TZProperty (character)

Inherited from Consultingwerk.XmlSerializable

Purpose:	Returns a value from a DATETIME-TZ property in the property store
Notes:

Parameters:
pcPropertyName	CHARACTER
	The name of the objects property
Returns	DATETIME-TZ
	The property value

Top

PROTECTED DATETIME GetDateTimeProperty (character)

Inherited from Consultingwerk.XmlSerializable

Purpose:	Returns a value from a DATETIME property in the property store
Notes:

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

Top

PROTECTED DECIMAL GetDecimalProperty (character)

Inherited from Consultingwerk.XmlSerializable

Purpose:	Returns a value from a DECIMAL property in the property store
Notes:

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

Top

PUBLIC CHARACTER GetExpression ()

Purpose:	Returns the Expression to be used in a Query String
Notes:

Returns	CHARACTER
	The CHARACTER Expression

Top

PROTECTED INT64 GetInt64Property (character)

Inherited from Consultingwerk.XmlSerializable

Purpose:	Returns a value from a INTEGER property in the property store
Notes:

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

Top

PROTECTED INTEGER GetIntegerProperty (character)

Inherited from Consultingwerk.XmlSerializable

Purpose:	Returns a value from a INTEGER property in the property store
Notes:

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

Top

PROTECTED LOGICAL GetLogicalProperty (character)

Inherited from Consultingwerk.XmlSerializable

Purpose:	Returns a value from a INTEGER property in the property store
Notes:

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

Top

PROTECTED LONGCHAR GetLongCharProperty (character)

Inherited from Consultingwerk.XmlSerializable

Purpose:	Returns a value from a LONGCHAR property in the property store
Notes:

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

Top

PROTECTED Progress.Lang.Object GetObjectProperty (character)

Inherited from Consultingwerk.XmlSerializable

Purpose:	Returns a value from a Progress.Lang.Object property in the property store
Notes:

Parameters:
pcPropertyName	CHARACTER
	The name of the objects property
Returns	Progress.Lang.Object
	The property value (object reference)

Top

PROTECTED RAW GetRawProperty (character)

Inherited from Consultingwerk.XmlSerializable

Purpose:	Returns a value from a RAW property in the property store
Notes:

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

Top

PROTECTED CHARACTER PropertyType (character)

Inherited from Consultingwerk.XmlSerializable

Purpose:	Returns the type of a property
Notes:	Throws an error, when the property is unknown

Parameters:
pcProperty	CHARACTER
	The name of the property
Returns	CHARACTER
	The type of the property

Top

PUBLIC LONGCHAR Serialize ()

Inherited from Consultingwerk.XmlSerializable

Purpose:	Returns an LONGCHAR representation of the object instance
Notes:

Returns	LONGCHAR
	The LONGCHAR representation of the ISerializable objects data

Top

PUBLIC HANDLE Serialize (handle)

Inherited from Consultingwerk.XmlSerializable

Purpose:	Serializes the properties of the current object instance to
	an existing X-NODEREF object
Notes:

Parameters:
phParent	HANDLE
	The reference to the parent XML Node or Document
Returns	HANDLE
	The X-NODEREF with the properties of the serialized object

Top

PUBLIC SerializeProperties (handle)

Inherited from Consultingwerk.XmlSerializable

Purpose:	Serializes the properties of this object instance as child nodes of
	the given node
Notes:

Parameters:
phObjectNode	HANDLE
	The reference to the X-NODEREF object that represents the node for the current instance

Top

PROTECTED SerializeProperty (handle, character, character)

Inherited from Consultingwerk.XmlSerializable

Purpose:	Serializes a single property value to the current parent XmlNode
Notes:	Allows to override the handling of individual properties during the
	XmlSerialization

Parameters:
phParentNode	HANDLE
	The reference to the parent XML Node
pcProperty	CHARACTER
	The name of the property in the JsonObject
pcType	CHARACTER
	The type of the property

Top

PROTECTED SetCharacterProperty (character, character)

Inherited from Consultingwerk.XmlSerializable

Purpose:	Assigns a CHARACTER property in the property store
Notes:

Parameters:
pcPropertyName	CHARACTER
	The name of the objects property
pcValue	CHARACTER
	The value of the objects property

Top

PROTECTED SetDateProperty (character, date)

Inherited from Consultingwerk.XmlSerializable

Purpose:	Assigns a DATE property in the property store
Notes:

Parameters:
pcPropertyName	CHARACTER
	The name of the objects property
pdaValue	DATE
	The value of the objects property

Top

PROTECTED SetDateTime-TZProperty (character, datetime-tz)

Inherited from Consultingwerk.XmlSerializable

Purpose:	Assigns a DATETIME-TZ property in the property store
Notes:

Parameters:
pcPropertyName	CHARACTER
	The name of the objects property
pdtValue	DATETIME-TZ
	The value of the objects property

Top

PROTECTED SetDateTimeProperty (character, datetime)

Inherited from Consultingwerk.XmlSerializable

Purpose:	Assigns a DATETIME property in the property store
Notes:

Parameters:
pcPropertyName	CHARACTER
	The name of the objects property
pdtValue	DATETIME
	The value of the objects property

Top

PROTECTED SetDecimalProperty (character, decimal)

Inherited from Consultingwerk.XmlSerializable

Purpose:	Assigns a DECIMAL property in the property store
Notes:

Parameters:
pcPropertyName	CHARACTER
	The name of the objects property
pdeValue	DECIMAL
	The value of the objects property

Top

PROTECTED SetInt64Property (character, int64)

Inherited from Consultingwerk.XmlSerializable

Purpose:	Assigns a INTEGER property in the property store
Notes:

Parameters:
pcPropertyName	CHARACTER
	The name of the objects property
piValue	INT64
	The value of the objects property

Top

PROTECTED SetIntegerProperty (character, integer)

Inherited from Consultingwerk.XmlSerializable

Purpose:	Assigns a INTEGER property in the property store
Notes:

Parameters:
pcPropertyName	CHARACTER
	The name of the objects property
piValue	INTEGER
	The value of the objects property

Top

PROTECTED SetLogicalProperty (character, logical)

Inherited from Consultingwerk.XmlSerializable

Purpose:	Assigns a LOGICAL property in the property store
Notes:

Parameters:
pcPropertyName	CHARACTER
	The name of the objects property
plValue	LOGICAL
	The value of the objects property

Top

PROTECTED SetLongcharProperty (character, longchar)

Inherited from Consultingwerk.XmlSerializable

Purpose:	Assigns a LOGICAL property in the property store
Notes:

Parameters:
pcPropertyName	CHARACTER
	The name of the objects property
plcValue	LONGCHAR
	The value of the objects property

Top

PROTECTED SetObjectProperty (character, Object)

Inherited from Consultingwerk.XmlSerializable

Purpose:	Assigns a Progress.Lang.Object property in the property store
Notes:

Parameters:
pcPropertyName	CHARACTER
	The name of the objects property
poValue	Progress.Lang.Object
	The object reference as the value of the objects property

Top

PROTECTED SetRawProperty (character, raw)

Inherited from Consultingwerk.XmlSerializable

Purpose:	Assigns a RAW property in the property store
Notes:

Parameters:
pcPropertyName	CHARACTER
	The name of the objects property
prValue	RAW
	The value of the objects property

Top

PUBLIC CHARACTER ToString ()

Purpose:	Returns a string that represents the current object.
Notes:

Returns	CHARACTER
	A string that represents the current object.

Top

PUBLIC LONGCHAR WriteXml ()

Inherited from Consultingwerk.XmlSerializable

Purpose:	Returns an LONGCHAR representation of the object instance
Notes:	This method is a facade to the XmlSerializable:Serialize method

Returns	LONGCHAR
	The LONGCHAR representation of the ISerializable objects data

Constructor Detail

Top

PUBLIC BufferFieldName ()

Purpose:	Constructor for the BufferFieldName class
Notes:

Top

PUBLIC BufferFieldName (character)

Purpose:	Constructor for the BufferFieldName class
Notes:	Supports db.table.field, table.field, field with and without index (extent)

Parameters:
pcFieldName	CHARACTER
	The field name

Top

PUBLIC BufferFieldName (character, character)

Purpose:	Constructor for the BufferFieldName class
Notes:

Parameters:
pcTableName	CHARACTER
	The table name
pcFieldName	CHARACTER
	The field name

Top

PUBLIC BufferFieldName (character, character, character)

Purpose:	Constructor for the BufferFieldName class
Notes:

Parameters:
pcDatabaseName	CHARACTER
	The database name
pcTableName	CHARACTER
	The table name
pcFieldName	CHARACTER
	The field name

Top

PUBLIC BufferFieldName (character, character, character, integer)

Purpose:	Constructor for the BufferFieldName class
Notes:

Parameters:
pcDatabaseName	CHARACTER
	The database name
pcTableName	CHARACTER
	The table name
pcFieldName	CHARACTER
	The field name
piIndex	INTEGER
	The field index (extent)

Top

PUBLIC BufferFieldName (character, character, integer)

Purpose:	Constructor for the BufferFieldName class
Notes:

Parameters:
pcTableName	CHARACTER
	The table name
pcFieldName	CHARACTER
	The field name
piIndex	INTEGER
	The field index (extent)

Top

PUBLIC BufferFieldName (handle)

Purpose:	Constructor for the BufferFieldName class
Notes:

Parameters:
phBufferField	HANDLE
	The Buffer Field to use to populate the buffer field name

Top

PUBLIC BufferFieldName (handle, character)

Purpose:	Constructor for the BufferFieldName class
Notes:

Parameters:
phBuffer	HANDLE
	The handle of the Buffer that contains the field
pcFieldName	CHARACTER
	The name of the Buffer field

Property Detail

Top

PUBLIC CHARACTER DatabaseName

Purpose:	Gets and sets the Database Name component
Notes:

Returns	CHARACTER

Top

PUBLIC CHARACTER FieldName

Purpose:	Gets and sets the Field Name component
Notes:

Returns	CHARACTER

Top

PUBLIC INTEGER Index

Purpose:	Gets and sets the Index component (0 for non EXTENT fields)
Notes:

Returns	INTEGER

Top

PUBLIC LOGICAL SerializeEmptyLists

Inherited from Consultingwerk.XmlSerializable

Purpose:	Gets and sets if during serialization empty lists (properties of type
	Consultingwerk.Framework.Base.IEnumerable) that do not contain any
	elements, will be serialized
Notes:	Setting this to TRUE allows to restore the previous behaviour on
	a case by case value

Returns	LOGICAL

Top

PUBLIC LOGICAL SerializeNullValues

Inherited from Consultingwerk.XmlSerializable

Purpose:	Gets and sets if Null-Values should be serialized
Notes:

Returns	LOGICAL

Top

PUBLIC CHARACTER TableName

Purpose:	Gets and sets the Table Name component
Notes:

Returns	CHARACTER

Top

PUBLIC LOGICAL UseSerializedTypeInformation

Inherited from Consultingwerk.XmlSerializable

Purpose:	Determines if the Serialization Routine will read and write the
	SerializedType attribute
Notes:

Returns	LOGICAL

info@consultingwerk.de http://www.consultingwerk.de 26.08.2016 08:25:41