Consultingwerk.Util.MessageSubSystem - SmartComponent Library

Namespace:

Consultingwerk.Util

Class

MessageSubSystem

Parent classes:

Progress.Lang.Object

Consultingwerk.JsonSerializable

Consultingwerk.CharacterHolder

Consultingwerk.Util.MessageSubSystem

Inherits:

Consultingwerk.CharacterHolder

Implements:

Ccs.Common.Support.ICharacterHolder, Consultingwerk.IJsonSerializable, Consultingwerk.IPrimitiveHolder, Consultingwerk.IQueryExpression

File:	MessageSubSystem
Purpose:	Holder class for LogManager message sub system
Syntax:	Represents a custom log entry type. Simplifies signatures
	of the LogManager:WriteMessage... methods as this type
	allows specific signatures for passing the custom logging
	types
Author(s):	Mike Fechner / Consultingwerk Ltd.
Created:	Mon May 05 20:13:39 CEST 2014

Top Method Summary

Options	Name	Purpose
#	AddSerializableProperties (character)	Add a list of Serializable Properties to the SerializableProperties property Inherited from Consultingwerk.JsonSerializable
+	Deserialize (longchar)	Deserializes a LONGCHAR representation of the state of the class instance Inherited from Consultingwerk.JsonSerializable
+	DeserializeFromJsonObject (JsonObject)	Initializes the object instance based on the passed in JsonObject representation of the object instance Inherited from Consultingwerk.JsonSerializable
#	DeserializeProperty (JsonObject, character, character)	Deserializes a single property value to the current JsonObject Inherited from Consultingwerk.JsonSerializable
+	LOGICAL Equals (Object)	Performs by-value comparison with another holder class Inherited from Consultingwerk.CharacterHolder
+	CHARACTER GetExpression ()	Returns the Expression to be used in a Query String Inherited from Consultingwerk.CharacterHolder
+	CHARACTER GetSerializableProperties ()	Returns the meta data of the serializable properties Inherited from Consultingwerk.JsonSerializable
+	CHARACTER GetValue ()	Returns the Value of the Holder instance Inherited from Consultingwerk.CharacterHolder
+	LONGCHAR Serialize ()	Returns a LONGCHAR representation of the state of the class instance Inherited from Consultingwerk.JsonSerializable
#	SerializeProperty (JsonObject, character, character)	Serializes a single property value to the current JsonObject Inherited from Consultingwerk.JsonSerializable
+	Consultingwerk.CharacterHolder SetUseSerializedTypeInformation (logical)	Assigns a value to the UseSerializedTypeInformation property Inherited from Consultingwerk.CharacterHolder
+	Progress.Json.ObjectModel.JsonObject ToJsonObject ()	Returns a JsonObject representation of the state of the class instance Inherited from Consultingwerk.JsonSerializable
+	CHARACTER ToString ()	Returns a Character representation of the value Overrides Consultingwerk.CharacterHolder:ToString ()
+	LONGCHAR WriteJson ()	Returns a LONGCHAR representation of the state of the class instance Inherited from Consultingwerk.JsonSerializable
+	LONGCHAR WriteXml ()	Returns an XML LONGCHAR representation of the object instance Inherited from Consultingwerk.JsonSerializable
+	HANDLE XmlSerialize (handle)	Serializes the properties of the current object instance to an existing X-NODEREF object Inherited from Consultingwerk.JsonSerializable
+	XmlSerializeProperties (handle)	Serializes the properties of this object instance as child nodes of the given node Inherited from Consultingwerk.JsonSerializable
#	XmlSerializeProperty (handle, character, character)	Serializes a single property value to the current parent XmlNode Inherited from Consultingwerk.JsonSerializable

Top Constructor Summary

	Options	Name	Purpose
	+	MessageSubSystem (character)	Constructor for the MessageSubSystem class
	+	MessageSubSystem (character, LoggingLevelEnum)	Constructor for the MessageSubSystem class

Top Property Summary

Options	Name	Purpose
+	Consultingwerk.CharacterHolder Empty	Inherited from Consultingwerk.CharacterHolder
+	Consultingwerk.IJsonDateTypeFormatter JsonDateTypeFormatter	Inherited from Consultingwerk.JsonSerializable
+	Consultingwerk.Framework.Enum.LoggingLevelEnum LoggingLevel
+	LOGICAL SerializeEmptyLists	Inherited from Consultingwerk.JsonSerializable
+	LOGICAL SerializeNullValues	Inherited from Consultingwerk.JsonSerializable
+	Consultingwerk.CharacterHolder UnknownValue	Inherited from Consultingwerk.CharacterHolder
+	LOGICAL UseSerializedTypeInformation	Inherited from Consultingwerk.JsonSerializable
+	CHARACTER Value	Inherited from Consultingwerk.CharacterHolder

Method Detail

Top

PROTECTED AddSerializableProperties (character)

Inherited from Consultingwerk.JsonSerializable

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.JsonSerializable

Purpose:	Deserializes a LONGCHAR representation of the state of the class instance
Notes:

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

Top

PUBLIC DeserializeFromJsonObject (JsonObject)

Inherited from Consultingwerk.JsonSerializable

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

Parameters:
poJsonObject	JsonObject
	The stored JsonObject representation of the objects data

Top

PROTECTED DeserializeProperty (JsonObject, character, character)

Inherited from Consultingwerk.JsonSerializable

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

Parameters:
poJsonObject	JsonObject
	The reference to the source JsonObject
pcProperty	CHARACTER
	The name of the property in the JsonObject
pcType	CHARACTER
	The type of the property

Top

PUBLIC LOGICAL Equals (Object)

Inherited from Consultingwerk.CharacterHolder

Purpose:	Performs by-value comparison with another holder class
Notes:	The provided object for comparison needs to be of the same type

Parameters:
poObject	Progress.Lang.Object
	The object to compare with the current instance
Returns	LOGICAL
	Logical value indicating if this object and the passed in object instance have the same value

Top

PUBLIC CHARACTER GetExpression ()

Inherited from Consultingwerk.CharacterHolder

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

Returns	CHARACTER
	The CHARACTER Expression

Top

PUBLIC CHARACTER GetSerializableProperties ()

Inherited from Consultingwerk.JsonSerializable

Purpose:	Returns the meta data of the serializable properties
Notes:

Returns	CHARACTER
	The serializable properties meta data as a comma delimited list

Top

PUBLIC CHARACTER GetValue ()

Inherited from Consultingwerk.CharacterHolder

Purpose:	Returns the Value of the Holder instance
Notes:	Unquoted value

Returns	CHARACTER
	The value as a CHARACTER

Top

PUBLIC LONGCHAR Serialize ()

Inherited from Consultingwerk.JsonSerializable

Purpose:	Returns a LONGCHAR representation of the state of the class instance
Notes:	Returns the classname together with the Json serialization

Returns	LONGCHAR
	The LONGCHAR representation of the ISerializable objects data

Top

PROTECTED SerializeProperty (JsonObject, character, character)

Inherited from Consultingwerk.JsonSerializable

Purpose:	Serializes a single property value to the current JsonObject
Notes:	Allows to override the handling of individual properties during the
	JsonSerialization

Parameters:
poJsonObject	JsonObject
	The reference to the target JsonObject
pcProperty	CHARACTER
	The name of the property in the JsonObject
pcType	CHARACTER
	The type of the property

Top

PUBLIC Consultingwerk.CharacterHolder SetUseSerializedTypeInformation (logical)

Inherited from Consultingwerk.CharacterHolder

Purpose:	Assigns a value to the UseSerializedTypeInformation property
Notes:

Parameters:
plValue	LOGICAL
	The value for the UseSerializedTypeInformation property
Returns	Consultingwerk.CharacterHolder
	The reference to the object instance itself

Top

PUBLIC Progress.Json.ObjectModel.JsonObject ToJsonObject ()

Inherited from Consultingwerk.JsonSerializable

Purpose:	Returns a JsonObject representation of the state of the class instance
Notes:	Returns the classname together with the Json serialization of the
	object

Returns	Progress.Json.ObjectModel.JsonObject
	The Progress.Json.ObjectModel.JsonObject representation of the ISerializable objects data

Top

PUBLIC CHARACTER ToString ()

Overrides Consultingwerk.CharacterHolder:ToString ()

Purpose:	Returns a Character representation of the value
Notes:

Returns	CHARACTER
	The Character representation of the value

Top

PUBLIC LONGCHAR WriteJson ()

Inherited from Consultingwerk.JsonSerializable

Purpose:	Returns a LONGCHAR representation of the state of the class instance
Notes:	Returns the classname together with the Json serialization
	This method is a facade to the JsonSerializable:Serialize method

Returns	LONGCHAR
	The LONGCHAR representation of the ISerializable objects data

Top

PUBLIC LONGCHAR WriteXml ()

Inherited from Consultingwerk.JsonSerializable

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

Returns	LONGCHAR
	The LONGCHAR representation of the ISerializable objects data

Top

PUBLIC HANDLE XmlSerialize (handle)

Inherited from Consultingwerk.JsonSerializable

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 XmlSerializeProperties (handle)

Inherited from Consultingwerk.JsonSerializable

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 XmlSerializeProperty (handle, character, character)

Inherited from Consultingwerk.JsonSerializable

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

Constructor Detail

Top

PUBLIC MessageSubSystem (character)

Purpose:	Constructor for the MessageSubSystem class
Notes:

Parameters:
pcMessageSubSys	CHARACTER
	The value for the Message Sub System

Top

PUBLIC MessageSubSystem (character, LoggingLevelEnum)

Purpose:	Constructor for the MessageSubSystem class
Notes:

Parameters:
pcMessageSubSys	CHARACTER
	The value for the Message Sub System
poLoggingLevel	Consultingwerk.Framework.Enum.LoggingLevelEnum
	The LoggingLevelEnum value (None, Errors, Basic, Verbose, Extended)

Property Detail

Top

PUBLIC Consultingwerk.CharacterHolder Empty

Inherited from Consultingwerk.CharacterHolder

Returns	Consultingwerk.CharacterHolder

Top

PUBLIC Consultingwerk.IJsonDateTypeFormatter JsonDateTypeFormatter

Inherited from Consultingwerk.JsonSerializable

Returns	Consultingwerk.IJsonDateTypeFormatter

Top

PUBLIC Consultingwerk.Framework.Enum.LoggingLevelEnum LoggingLevel

Returns	Consultingwerk.Framework.Enum.LoggingLevelEnum

Top

PUBLIC LOGICAL SerializeEmptyLists

Inherited from Consultingwerk.JsonSerializable

Returns	LOGICAL

Top

PUBLIC LOGICAL SerializeNullValues

Inherited from Consultingwerk.JsonSerializable

Returns	LOGICAL

Top

PUBLIC Consultingwerk.CharacterHolder UnknownValue

Inherited from Consultingwerk.CharacterHolder

Returns	Consultingwerk.CharacterHolder

Top

PUBLIC LOGICAL UseSerializedTypeInformation

Inherited from Consultingwerk.JsonSerializable

Returns	LOGICAL

Top

PUBLIC CHARACTER Value

Inherited from Consultingwerk.CharacterHolder

Returns	CHARACTER

info@consultingwerk.de http://www.consultingwerk.de 04.02.2020 23:39:24