Namespace: Consultingwerk.SmartFramework.Repository
Class 
AnnotationBasedFormParameter Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.JsonSerializable
Consultingwerk.ParameterObject
Consultingwerk.SmartFramework.Repository.AnnotationBasedFormParameter

Inherits: Consultingwerk.ParameterObject
Implements: Consultingwerk.SmartFramework.Repository.IAnnotationBasedFormParameter, Consultingwerk.IJsonSerializable
SERIALIZABLE

File:AnnotationBasedFormParameter
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:02.01.2020 07:40:27

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
# CHARACTER AddSerializableProperties () Adds serializable properties from the calling class using ABL reflection. Supported from OpenEdge 11.6 on only.
Inherited from Consultingwerk.JsonSerializable
# AddSerializableProperties (character) Add a list of Serializable Properties to the SerializableProperties property
Inherited from Consultingwerk.JsonSerializable
# CHARACTER AddSerializableProperties (Class) Adds serializable properties from the given class using ABL reflection. Supported from OpenEdge 11.6 on only.
Inherited from Consultingwerk.JsonSerializable
+ Consultingwerk.SmartFramework.Repository.AnnotationBasedFormParameter BusinessEntityName (character) Property Setter for the BusinessEntityName property
+ 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, character) Deserializes a single property value to the current JsonObject
Inherited from Consultingwerk.JsonSerializable
+ Consultingwerk.SmartFramework.Repository.AnnotationBasedFormParameter Environment (character) Property Setter for the Environment property
+ LOGICAL Equals (Object) Compares this object to the passed in object by value
Inherited from Consultingwerk.ParameterObject
+ Consultingwerk.SmartFramework.Repository.AnnotationBasedFormParameter FormIcon (character) Property Setter for the FormIcon property
+ Consultingwerk.SmartFramework.Repository.AnnotationBasedFormParameter FormLogicClassName (character) Property Setter for the FormLogicClassName property
+ Consultingwerk.SmartFramework.Repository.AnnotationBasedFormParameter FormTitle (character) Property Setter for the FormTitle property
# IEnumerable GetEnumerableInstance (character) Returns an instance of the enumerable type
Inherited from Consultingwerk.JsonSerializable
+ RAW GetHashCode () Returns an 64bit RAW Hash Value representing the object instance
Inherited from Consultingwerk.ParameterObject
+ CHARACTER GetSerializableProperties () Returns the meta data of the serializable properties
Inherited from Consultingwerk.JsonSerializable
+ CHARACTER GetSerializeName (character) Returns the SerializeName of a property
Inherited from Consultingwerk.JsonSerializable
# LazyAddSerializableProperties () Adds serializable properties from the calling class using ABL reflection. Supported from OpenEdge 11.6 on only.
Inherited from Consultingwerk.JsonSerializable
+ LONGCHAR Serialize () Returns a LONGCHAR representation of the state of the class instance
Inherited from Consultingwerk.JsonSerializable
# SerializeProperty (JsonObject, character, character, character) Serializes a single property value to the current JsonObject
Inherited from Consultingwerk.JsonSerializable
+ Progress.Json.ObjectModel.JsonObject ToJsonObject () Returns a JsonObject representation of the state of the class instance
Inherited from Consultingwerk.JsonSerializable
+ CHARACTER ToString () Returns a string representation of the object
Inherited from Consultingwerk.ParameterObject
+ Consultingwerk.SmartFramework.Repository.AnnotationBasedFormParameter ViewerLogicClassName (character) Property Setter for the ViewerLogicClassName property
+ Consultingwerk.SmartFramework.Repository.AnnotationBasedFormParameter ViewName (character) Property Setter for the ViewName property
+ 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
+ AnnotationBasedFormParameter () Constructor for the AnnotationBasedFormParameter class
+ AnnotationBasedFormParameter (character, character, character, character, character, character, character) Constructor for the AnnotationBasedFormParameter class

Top Property Summary
Options Name Purpose
+ CHARACTER BusinessEntityName
+ CHARACTER Environment
+ CHARACTER FormIcon
+ CHARACTER FormLogicClassName
+ CHARACTER FormTitle
+ Consultingwerk.IJsonDateTypeFormatter JsonDateTypeFormatter
Inherited from Consultingwerk.JsonSerializable
+ LOGICAL SerializeEmptyLists
Inherited from Consultingwerk.JsonSerializable
# CHARACTER SerializeNames
Inherited from Consultingwerk.JsonSerializable
+ LOGICAL SerializeNullValues
Inherited from Consultingwerk.JsonSerializable
+ LOGICAL UseSerializedTypeInformation
Inherited from Consultingwerk.JsonSerializable
+ CHARACTER ViewerLogicClassName
+ CHARACTER ViewName


Method Detail
Top

PROTECTED CHARACTER AddSerializableProperties ()
Inherited from Consultingwerk.JsonSerializable
Purpose: Adds serializable properties from the calling class using ABL reflection.
Supported from OpenEdge 11.6 on only.
Notes: Adds properties of the following types, does not add properties of
the base classes, adds only PUBLIC properties:
- CHARACTER
- CHARACTER EXTENT
- DATE
- DATE EXTENT
- DATETIME
- DATETIME EXTENT
- DATETIME-TZ
- DATETIME-TZ EXTENT
- DECIMAL
- DECIMAL EXTENT
- INT64
- INT64 EXTENT
- INTEGER
- INTEGER EXTENT
- LOGICAL
- LOGICAL EXTENT
- LONGCHAR
- LONGCHAR EXTENT
- RAW
- RAW EXTENT
- RECID
- RECID EXTENT
- ROWID
- ROWID EXTENT
- Progress.Json.ObjectModel.JsonArray
- Progress.Json.ObjectModel.JsonObject
- ENUM
- Consultingwerk.Enum
- Consultingwerk.Framework.Base.IEnumerable
- Consultingwerk.JsonSerializable
- Consultingwerk.JsonSerializable EXTENT

Returns CHARACTER
The value of the SerializableProperties property
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

PROTECTED CHARACTER AddSerializableProperties (Class)
Inherited from Consultingwerk.JsonSerializable
Purpose: Adds serializable properties from the given class using ABL reflection.
Supported from OpenEdge 11.6 on only.
Notes: Adds properties of the following types, does not add properties of
the base classes, adds only PUBLIC properties:
- CHARACTER
- CHARACTER EXTENT
- DATE
- DATE EXTENT
- DATETIME
- DATETIME EXTENT
- DATETIME-TZ
- DATETIME-TZ EXTENT
- DECIMAL
- DECIMAL EXTENT
- INT64
- INT64 EXTENT
- INTEGER
- INTEGER EXTENT
- LOGICAL
- LOGICAL EXTENT
- LONGCHAR
- LONGCHAR EXTENT
- RAW
- RAW EXTENT
- RECID
- RECID EXTENT
- ROWID
- ROWID EXTENT
- Progress.Json.ObjectModel.JsonArray
- Progress.Json.ObjectModel.JsonObject
- ENUM
- Consultingwerk.Enum
- Consultingwerk.Framework.Base.IEnumerable
- Consultingwerk.JsonSerializable
- Consultingwerk.JsonSerializable EXTENT

Parameters:
poClass Progress.Lang.Class
The declaring class
Returns CHARACTER
The value of the SerializableProperties property
Top

PUBLIC Consultingwerk.SmartFramework.Repository.AnnotationBasedFormParameter BusinessEntityName (character)
Purpose: Property Setter for the BusinessEntityName property
Notes:

Parameters:
pBusinessEntityName CHARACTER
The value for the BusinessEntityName property
Returns Consultingwerk.SmartFramework.Repository.AnnotationBasedFormParameter
The reference to the object instance
Top

PUBLIC Deserialize (longchar)
Inherited from Consultingwerk.JsonSerializable
Purpose: Deserializes a LONGCHAR representation of the state of the class instance
Notes:

Parameters:
pcSerializedRepresentation 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, 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
pcJsonProperty CHARACTER
The name of the property in the JsonObject
pcType CHARACTER
The type of the property
Top

PUBLIC Consultingwerk.SmartFramework.Repository.AnnotationBasedFormParameter Environment (character)
Purpose: Property Setter for the Environment property
Notes:

Parameters:
pEnvironment CHARACTER
The value for the Environment property
Returns Consultingwerk.SmartFramework.Repository.AnnotationBasedFormParameter
The reference to the object instance
Top

PUBLIC LOGICAL Equals (Object)
Inherited from Consultingwerk.ParameterObject
Purpose: Compares this object to the passed in object by value
Notes:

Parameters:
poObject Progress.Lang.Object
The reference to the object to compare to
Returns LOGICAL
Logical value indicating if the two objects are identical by value
Top

PUBLIC Consultingwerk.SmartFramework.Repository.AnnotationBasedFormParameter FormIcon (character)
Purpose: Property Setter for the FormIcon property
Notes:

Parameters:
pFormIcon CHARACTER
The value for the FormIcon property
Returns Consultingwerk.SmartFramework.Repository.AnnotationBasedFormParameter
The reference to the object instance
Top

PUBLIC Consultingwerk.SmartFramework.Repository.AnnotationBasedFormParameter FormLogicClassName (character)
Purpose: Property Setter for the FormLogicClassName property
Notes:

Parameters:
pFormLogicClassName CHARACTER
The value for the FormLogicClassName property
Returns Consultingwerk.SmartFramework.Repository.AnnotationBasedFormParameter
The reference to the object instance
Top

PUBLIC Consultingwerk.SmartFramework.Repository.AnnotationBasedFormParameter FormTitle (character)
Purpose: Property Setter for the FormTitle property
Notes:

Parameters:
pFormTitle CHARACTER
The value for the FormTitle property
Returns Consultingwerk.SmartFramework.Repository.AnnotationBasedFormParameter
The reference to the object instance
Top

PROTECTED IEnumerable GetEnumerableInstance (character)
Inherited from Consultingwerk.JsonSerializable
Purpose: Returns an instance of the enumerable type
Notes: When the property value is referencing a value list instance, this
instance is returned. If not, we attempt to create a new instance

Parameters:
pcProperty CHARACTER
The name of the List property
Returns IEnumerable
The instance of the enumerable type
Top

PUBLIC RAW GetHashCode ()
Inherited from Consultingwerk.ParameterObject
Purpose: Returns an 64bit RAW Hash Value representing the object instance
Notes: Based on the ABL SHA-512 implementation

Returns RAW
The RAW Hash Value representing the object instance
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 GetSerializeName (character)
Inherited from Consultingwerk.JsonSerializable
Purpose: Returns the SerializeName of a property
Notes: See property SerializeNames for details

Parameters:
pcPropertyName CHARACTER
The name of the property
Returns CHARACTER
The SerializeName of the property
Top

PROTECTED LazyAddSerializableProperties ()
Inherited from Consultingwerk.JsonSerializable
Purpose: Adds serializable properties from the calling class using ABL reflection.
Supported from OpenEdge 11.6 on only.
Notes:

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, 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
pcJsonProperty CHARACTER
The name of the property in the JsonObject
pcType CHARACTER
The type of the property
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 ()
Inherited from Consultingwerk.ParameterObject
Purpose: Returns a string representation of the object
Notes:

Returns CHARACTER
The string representation of the object
Top

PUBLIC Consultingwerk.SmartFramework.Repository.AnnotationBasedFormParameter ViewerLogicClassName (character)
Purpose: Property Setter for the ViewerLogicClassName property
Notes:

Parameters:
pViewerLogicClassName CHARACTER
The value for the ViewerLogicClassName property
Returns Consultingwerk.SmartFramework.Repository.AnnotationBasedFormParameter
The reference to the object instance
Top

PUBLIC Consultingwerk.SmartFramework.Repository.AnnotationBasedFormParameter ViewName (character)
Purpose: Property Setter for the ViewName property
Notes:

Parameters:
pViewName CHARACTER
The value for the ViewName property
Returns Consultingwerk.SmartFramework.Repository.AnnotationBasedFormParameter
The reference to the object instance
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 AnnotationBasedFormParameter ()
Purpose: Constructor for the AnnotationBasedFormParameter class
Notes:

Top

PUBLIC AnnotationBasedFormParameter (character, character, character, character, character, character, character)
Purpose: Constructor for the AnnotationBasedFormParameter class
Notes:

Parameters:
pBusinessEntityName CHARACTER
The value for the BusinessEntityName property
pViewName CHARACTER
The value for the ViewName property
pFormLogicClassName CHARACTER
The value for the FormLogicClassName property
pViewerLogicClassName CHARACTER
The value for the ViewerLogicClassName property
pFormIcon CHARACTER
The value for the FormIcon property
pFormTitle CHARACTER
The value for the FormTitle property
pEnvironment CHARACTER
The value for the Environment property


Property Detail
Top

PUBLIC CHARACTER BusinessEntityName

Returns CHARACTER
Top

PUBLIC CHARACTER Environment

Returns CHARACTER
Top

PUBLIC CHARACTER FormIcon

Returns CHARACTER
Top

PUBLIC CHARACTER FormLogicClassName

Returns CHARACTER
Top

PUBLIC CHARACTER FormTitle

Returns CHARACTER
Top

PUBLIC Consultingwerk.IJsonDateTypeFormatter JsonDateTypeFormatter
Inherited from Consultingwerk.JsonSerializable

Returns Consultingwerk.IJsonDateTypeFormatter
Top

PUBLIC LOGICAL SerializeEmptyLists
Inherited from Consultingwerk.JsonSerializable

Returns LOGICAL
Top

PROTECTED CHARACTER SerializeNames
Inherited from Consultingwerk.JsonSerializable

Returns CHARACTER
Top

PUBLIC LOGICAL SerializeNullValues
Inherited from Consultingwerk.JsonSerializable

Returns LOGICAL
Top

PUBLIC LOGICAL UseSerializedTypeInformation
Inherited from Consultingwerk.JsonSerializable

Returns LOGICAL
Top

PUBLIC CHARACTER ViewerLogicClassName

Returns CHARACTER
Top

PUBLIC CHARACTER ViewName

Returns CHARACTER


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       08.12.2024 13:08:20