Consultingwerk.OERA.RestResource.RestMethod

Namespace:

Consultingwerk.OERA.RestResource

Class

RestMethod

Parent classes:

Progress.Lang.Object

Consultingwerk.JsonSerializable

Consultingwerk.OERA.RestResource.RestMethod

Inherits:

Consultingwerk.JsonSerializable

Implements:

Consultingwerk.IJsonSerializable, Consultingwerk.OERA.RestResource.IRestMethod

File:	RestMethod
Purpose:	Describes a Business Service method which provides a
	RESTful endpoint
Author(s):	Mike Fechner / Consultingwerk Ltd.
Created:	21.05.2018 16:46:11

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
+	CHARACTER GetSerializableProperties ()	Returns the meta data of the serializable properties 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)	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 CHARACTER Representation of the RestMethod
+	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
	+	RestMethod ()	Constructor for the RestMethod class
	+	RestMethod (SerializableAnnotation, character, character)	Constructor for the RestMethod class

Top Property Summary

Options	Name	Purpose
+	CHARACTER Address
+	CHARACTER ClassName
+	Consultingwerk.IJsonDateTypeFormatter JsonDateTypeFormatter	Inherited from Consultingwerk.JsonSerializable
+	CHARACTER MethodName
+	CHARACTER ParameterClassName
+	Consultingwerk.ListNameValuePair ParameterSchemas
+	CHARACTER Request
+	CHARACTER RequestMethod
+	CHARACTER Response
+	LOGICAL SerializeEmptyLists	Inherited from Consultingwerk.JsonSerializable
+	LOGICAL SerializeNullValues	Inherited from Consultingwerk.JsonSerializable
+	LOGICAL UseSerializedTypeInformation	Inherited from Consultingwerk.JsonSerializable

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

Purpose:	Returns a CHARACTER Representation of the RestMethod
Notes:

Returns	CHARACTER
	The CHARACTER Representation of the RestMethod

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 RestMethod ()

Purpose:	Constructor for the RestMethod class
Notes:

Top

PUBLIC RestMethod (SerializableAnnotation, character, character)

Purpose:	Constructor for the RestMethod class
Notes:

Parameters:
poAnnotation	Consultingwerk.Framework.TypeDescriptor.SerializableAnnotation
	The class annotation that provides the information for the REST Method
pcClassName	CHARACTER
	The name of the Business Entity or Business Task class
pcMethodName	CHARACTER
	The name of the Method

Property Detail

Top

PUBLIC CHARACTER Address

Returns	CHARACTER

Top

PUBLIC CHARACTER ClassName

Returns	CHARACTER

Top

PUBLIC Consultingwerk.IJsonDateTypeFormatter JsonDateTypeFormatter

Inherited from Consultingwerk.JsonSerializable

Returns	Consultingwerk.IJsonDateTypeFormatter

Top

PUBLIC CHARACTER MethodName

Returns	CHARACTER

Top

PUBLIC CHARACTER ParameterClassName

Returns	CHARACTER

Top

PUBLIC Consultingwerk.ListNameValuePair ParameterSchemas

Returns	Consultingwerk.ListNameValuePair

Top

PUBLIC CHARACTER Request

Returns	CHARACTER

Top

PUBLIC CHARACTER RequestMethod

Returns	CHARACTER

Top

PUBLIC CHARACTER Response

Returns	CHARACTER

Top

PUBLIC LOGICAL SerializeEmptyLists

Inherited from Consultingwerk.JsonSerializable

Returns	LOGICAL

Top

PUBLIC LOGICAL SerializeNullValues

Inherited from Consultingwerk.JsonSerializable

Returns	LOGICAL

Top

PUBLIC LOGICAL UseSerializedTypeInformation

Inherited from Consultingwerk.JsonSerializable

Returns	LOGICAL

info@consultingwerk.de http://www.consultingwerk.de 04.02.2020 23:13:47