Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebFieldBuffer

Namespace:

Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb

Class

ProparseWebFieldBuffer

Parent classes:

Progress.Lang.Object

Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject

Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebFieldBuffer

Inherits:

Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject

Implements:

Consultingwerk.Studio.ProparseApi.IFieldBuffer

File:	ProparseWebFieldBuffer
Purpose:	Represents a Field Buffer
Author(s):	Sebastian Wandel / Consultingwerk Ltd.
Created:	Fri Oct 23 13:31:43 CEST 2020
	Purpose: Returns the Buffer reference
	Notes:

Top Method Summary

Options	Name	Purpose
+	Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebFieldBuffer Array (IProparseWebSession, JsonArray)	Turns a JsonArray into an array of ProparseWebFieldBuffer
#	LOGICAL CanGetProperty (JsonObject, character)	Helper method to check whether a property can be retrieved from a JSON object Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
#	Consultingwerk.Studio.ProparseApi.INode GetNode (character)	Helper method to get a node from the backend and create the object Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
#	Progress.Lang.Object PostRequest (character, JsonConstruct)	Executes a POST request on the server Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
#	Progress.Json.ObjectModel.JsonArray RequestJsonArray (character)	Helper method to get a JSON array from the server Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
#	Progress.Json.ObjectModel.JsonObject RequestJsonObject (character)	Helper method to get a JSON object from the server Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject

Top Constructor Summary

	Options	Name	Purpose
	+	ProparseWebFieldBuffer (IProparseWebSession, JsonObject)	Constructor for the ProparseWebFieldBuffer class

Top Property Summary

Options	Name	Purpose
#	Progress.Json.ObjectModel.JsonObject BaseJson	Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
+	Consultingwerk.Studio.ProparseApi.ITableBuffer Buffer
+	CHARACTER ClassName
+	CHARACTER DataType
+	LOGICAL Exported
+	INTEGER Extent
+	Consultingwerk.Studio.ProparseApi.IField Field
+	CHARACTER FullName
+	LOGICAL Imported
#	Progress.Json.ObjectModel.JsonObject Links	Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
+	CHARACTER Name
#	Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.IProparseWebSession Session	Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject

Method Detail

Top

PUBLIC Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebFieldBuffer Array (IProparseWebSession, JsonArray)

Purpose:	Turns a JsonArray into an array of ProparseWebFieldBuffer
Notes:

Parameters:
poSession	Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.IProparseWebSession
	The session for which this array is created
poJsonArray	Progress.Json.ObjectModel.JsonArray
	The source JsonArray
Returns	Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebFieldBuffer
	The resulting ProparseWebFieldBuffer array

Top

PROTECTED LOGICAL CanGetProperty (JsonObject, character)

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject

Purpose:	Helper method to check whether a property can be retrieved from a JSON object
Notes:

Parameters:
poJson	Progress.Json.ObjectModel.JsonObject
	The Json object to retrieve the property from
pcProperty	CHARACTER
	Name of the property to retrieve
Returns	LOGICAL
	TRUE/FALSE whether pcProperty can be retrieved from poJson

Top

PROTECTED Consultingwerk.Studio.ProparseApi.INode GetNode (character)

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject

Purpose:	Helper method to get a node from the backend and create the object
Notes:

Parameters:
pcLink	CHARACTER
	Link to the node resource
Returns	Consultingwerk.Studio.ProparseApi.INode
	The requested node

Top

PROTECTED Progress.Lang.Object PostRequest (character, JsonConstruct)

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject

Purpose:	Executes a POST request on the server
Notes:

Parameters:
pcUri	CHARACTER
	URI for the request
poJson	Progress.Json.ObjectModel.JsonConstruct
	Content for the request
Returns	Progress.Lang.Object
	The response entity

Top

PROTECTED Progress.Json.ObjectModel.JsonArray RequestJsonArray (character)

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject

Purpose:	Helper method to get a JSON array from the server
Notes:

Parameters:
pcRequestLink	CHARACTER
	Link to the requested resource
Returns	Progress.Json.ObjectModel.JsonArray
	JSON array from the response

Top

PROTECTED Progress.Json.ObjectModel.JsonObject RequestJsonObject (character)

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject

Purpose:	Helper method to get a JSON object from the server
Notes:

Parameters:
pcRequestLink	CHARACTER
	Link to the requested resource
Returns	Progress.Json.ObjectModel.JsonObject
	JSON object from the response

Constructor Detail

Top

PUBLIC ProparseWebFieldBuffer (IProparseWebSession, JsonObject)

Purpose:	Constructor for the ProparseWebFieldBuffer class
Notes:

Parameters:
poSession	Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.IProparseWebSession
	The session for which this object is being created, also holds HttpClient and JSessionID
poJson	Progress.Json.ObjectModel.JsonObject
	The JsonObject from which this object is being created

Property Detail

Top

PROTECTED Progress.Json.ObjectModel.JsonObject BaseJson

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject

Returns	Progress.Json.ObjectModel.JsonObject

Top

PUBLIC Consultingwerk.Studio.ProparseApi.ITableBuffer Buffer

Returns	Consultingwerk.Studio.ProparseApi.ITableBuffer

Top

PUBLIC CHARACTER ClassName

Returns	CHARACTER

Top

PUBLIC CHARACTER DataType

Returns	CHARACTER

Top

PUBLIC LOGICAL Exported

Returns	LOGICAL

Top

PUBLIC INTEGER Extent

Returns	INTEGER

Top

PUBLIC Consultingwerk.Studio.ProparseApi.IField Field

Returns	Consultingwerk.Studio.ProparseApi.IField

Top

PUBLIC CHARACTER FullName

Returns	CHARACTER

Top

PUBLIC LOGICAL Imported

Returns	LOGICAL

Top

PROTECTED Progress.Json.ObjectModel.JsonObject Links

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject

Returns	Progress.Json.ObjectModel.JsonObject

Top

PUBLIC CHARACTER Name

Returns	CHARACTER

Top

PROTECTED Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.IProparseWebSession Session

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject

Returns	Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.IProparseWebSession

info@consultingwerk.de http://www.consultingwerk.de 15.04.2024 06:16:03