Consultingwerk.OERA.JsdoGenericService.CatalogV14

Namespace:

Consultingwerk.OERA.JsdoGenericService

Class

CatalogV14

Parent classes:

Progress.Lang.Object

Consultingwerk.OERA.JsdoGenericService.CatalogV12

Consultingwerk.OERA.JsdoGenericService.CatalogV14

Inherits:

Consultingwerk.OERA.JsdoGenericService.CatalogV12

Implements:

Consultingwerk.OERA.JsdoGenericService.ICatalog

File:	CatalogV14
Purpose:	Generic JSON/JSDO Catalog generation, V1.4 (OpenEdge 11.6.2)
	with Kendo UI Builder extension (Star*Nova)
Author(s):	Mike Fechner / Consultingwerk Ltd.
Created:	Thu Aug 04 21:03:02 CEST 2016
	Purpose: Constructor for the CatalogV14 class
	Notes:

Top Method Summary

Options	Name	Purpose
#	AddColumnAttributes (JsonObject, character, character, handle)	Adds a boolean attribute to all table columns based on a list of columns
#	Consultingwerk.OERA.BusinessEntityDescriptor.IBusinessEntityDescriptor GetBusinessEntityDescriptor (character)	Retrieves the Business Entity Descriptor of the Business Entity Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12
+	Progress.Json.ObjectModel.JsonObject GetCatalogForBusinessEntity (character, RestServiceAddress)	Returns the Catalog for a given Business Entity Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12
+	Progress.Json.ObjectModel.JsonObject GetCatalogForBusinessEntity (character, RestServiceAddress, character)	Returns the Catalog for a given Business Entity Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12
+	GetCatalogForBusinessEntity (character, RestServiceAddress, longchar)	Returns the Catalog for a given Business Entity Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12
+	Progress.Json.ObjectModel.JsonObject GetCatalogForBusinessTask (IBusinessTaskCatalogData, RestServiceAddress)	Returns the Catalog for a given Business Task Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12
+	Progress.Json.ObjectModel.JsonObject GetDatasetSchema (handle)	Returns the JSON Schema description for the ProDataset Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12
+	Progress.Json.ObjectModel.JsonObject GetOperation (character, logical, character, character)	Returns an Operation with the given parameters Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12
+	Progress.Json.ObjectModel.JsonObject GetOperation (character, logical, character, character, character)	Returns an Operation with the given parameters Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12
+	Progress.Json.ObjectModel.JsonObject GetOperation (character, logical, character, character, character, character[], character[])	Returns an Operation with the given parameters Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12
+	Progress.Json.ObjectModel.JsonObject GetOperation (character, logical, character, character, character[], character[])	Returns an Operation with the given parameters Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12
+	Progress.Json.ObjectModel.JsonArray GetOperations (character, character)	Returns the Array of REST Operations for the given Dataset Name Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12
+	Progress.Json.ObjectModel.JsonArray GetOperations (IBusinessTaskCatalogData)	Returns the Array of REST Operations for the given Dataset Name Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12
+	Progress.Json.ObjectModel.JsonArray GetRelations (handle)	Returns the JSON Schema description of the Relations for the ProDataset Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12
#	Progress.Json.ObjectModel.JsonObject GetResource (character, handle)	Returns a Resource instance Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12
#	Progress.Json.ObjectModel.JsonObject GetResource (IBusinessTaskCatalogData, HandleList)	Returns a Resource instance Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12
+	Progress.Json.ObjectModel.JsonObject GetSchema (handle)	Returns the JSON Schema description for the ProDataset Overrides Consultingwerk.OERA.JsdoGenericService.CatalogV12:GetSchema (handle)
#	Progress.Json.ObjectModel.JsonObject GetService (character, RestServiceAddress, handle)	Returns a Service instance Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12
#	Progress.Json.ObjectModel.JsonObject GetService (IBusinessTaskCatalogData, RestServiceAddress, HandleList)	Returns a Service instance Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12
#	Progress.Json.ObjectModel.JsonObject GetSmartRestrictions (character)	Returns the JSON Object with the information about the restrictions Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12

Top Constructor Summary

	Options	Name	Purpose
	+	CatalogV14 ()	Constructor for the CatalogV14 class

Top Property Summary

	Options	Name	Purpose
	+	CHARACTER CatalogVersion	Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12
	#	CHARACTER EntityName	Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12

Method Detail

Top

PROTECTED AddColumnAttributes (JsonObject, character, character, handle)

Purpose:	Adds a boolean attribute to all table columns based on
	a list of columns
Notes:	Used for ReadOnly, Mandatory, non filterable and non sortable
	Columns

Parameters:
poProperties	Progress.Json.ObjectModel.JsonObject
	The JsonObject representing the columns of a table in the catalog
pcAttributeName	CHARACTER
	The attribute name to attach to the column
pcColumns	CHARACTER
	The comma delimited list of columns to add the attribute to
phBuffer	HANDLE
	The handle of the buffer to determine the field's SERIALIZE-NAME

Top

PROTECTED Consultingwerk.OERA.BusinessEntityDescriptor.IBusinessEntityDescriptor GetBusinessEntityDescriptor (character)

Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12

Purpose:	Retrieves the Business Entity Descriptor of the Business Entity
Notes:

Parameters:
pcEntityName	CHARACTER
	The name of the Business Entity
Returns	Consultingwerk.OERA.BusinessEntityDescriptor.IBusinessEntityDescriptor
	The IBusinessEntityDescriptor instance

Top

PUBLIC Progress.Json.ObjectModel.JsonObject GetCatalogForBusinessEntity (character, RestServiceAddress)

Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12

Purpose:	Returns the Catalog for a given Business Entity
Notes:	Defaults to the count method type of the .restapplicationsettings file

Parameters:
pcEntityName	CHARACTER
	The name of the Business Entity
poAddress	Consultingwerk.OERA.JsdoGenericService.RestServiceAddress
	The RestServiceAddress to include in the catalog output
Returns	Progress.Json.ObjectModel.JsonObject
	The JSON Object describing the Catalog for the Business Entity

Top

PUBLIC Progress.Json.ObjectModel.JsonObject GetCatalogForBusinessEntity (character, RestServiceAddress, character)

Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12

Purpose:	Returns the Catalog for a given Business Entity
Notes:

Parameters:
pcEntityName	CHARACTER
	The name of the Business Entity
poAddress	Consultingwerk.OERA.JsdoGenericService.RestServiceAddress
	The RestServiceAddress to include in the catalog output
pcCountMethodType	CHARACTER
	The type (count/invoke) for the count method
Returns	Progress.Json.ObjectModel.JsonObject
	The JSON Object describing the Catalog for the Business Entity

Top

PUBLIC GetCatalogForBusinessEntity (character, RestServiceAddress, longchar)

Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12

Purpose:	Returns the Catalog for a given Business Entity
Notes:

Parameters:
pcEntityName	CHARACTER
	The name of the Business Entity
poAddress	Consultingwerk.OERA.JsdoGenericService.RestServiceAddress
	The RestServiceAddress to include in the catalog output
pcJsonCatalog	LONGCHAR
	OUTPUT The JSON Catalog for the Business Entity

Top

PUBLIC Progress.Json.ObjectModel.JsonObject GetCatalogForBusinessTask (IBusinessTaskCatalogData, RestServiceAddress)

Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12

Purpose:	Returns the Catalog for a given Business Task
Notes:

Parameters:
poBusinessTask	Consultingwerk.OERA.IBusinessTaskCatalogData
	The name of the Business Task
poAddress	Consultingwerk.OERA.JsdoGenericService.RestServiceAddress
	The RestServiceAddress to include in the catalog output
Returns	Progress.Json.ObjectModel.JsonObject
	The JSON Object describing the Catalog for the Business Task

Top

PUBLIC Progress.Json.ObjectModel.JsonObject GetDatasetSchema (handle)

Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12

Purpose:	Returns the JSON Schema description for the ProDataset
Notes:	Does not include the schema envelope

Parameters:
phDataset	HANDLE
	The ProDataset to return the schema for
Returns	Progress.Json.ObjectModel.JsonObject
	The JsonObject representing the schema

Top

PUBLIC Progress.Json.ObjectModel.JsonObject GetOperation (character, logical, character, character)

Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12

Purpose:	Returns an Operation with the given parameters
Notes:

Parameters:
pcPath	CHARACTER
	The path of the operation
plUseBeforeImage	LOGICAL
	Logical value indicating the use of before image
pcType	CHARACTER
	The type of the operation
pcVerb	CHARACTER
	The http verb of the operation
Returns	Progress.Json.ObjectModel.JsonObject
	The JsonObject representing an operation

Top

PUBLIC Progress.Json.ObjectModel.JsonObject GetOperation (character, logical, character, character, character)

Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12

Purpose:	Returns an Operation with the given parameters
Notes:

Parameters:
pcPath	CHARACTER
	The path of the operation
plUseBeforeImage	LOGICAL
	Logical value indicating the use of before image
pcType	CHARACTER
	The type of the operation
pcVerb	CHARACTER
	The http verb of the operation
pcName	CHARACTER
	The name of the operation
Returns	Progress.Json.ObjectModel.JsonObject
	The JsonObject representing an operation

Top

PUBLIC Progress.Json.ObjectModel.JsonObject GetOperation (character, logical, character, character, character, character[], character[])

Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12

Purpose:	Returns an Operation with the given parameters
Notes:

Parameters:
pcPath	CHARACTER
	The path of the operation
plUseBeforeImage	LOGICAL
	Logical value indicating the use of before image
pcType	CHARACTER
	The type of the operation
pcVerb	CHARACTER
	The http verb of the operation
pcName	CHARACTER
	The method name
pcParameterNames	CHARACTER
	The names of the operation parameters
pcParameterTypes	CHARACTER
	The types of the operation parameters
Returns	Progress.Json.ObjectModel.JsonObject
	The JsonObject representing an operation

Top

PUBLIC Progress.Json.ObjectModel.JsonObject GetOperation (character, logical, character, character, character[], character[])

Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12

Purpose:	Returns an Operation with the given parameters
Notes:

Parameters:
pcPath	CHARACTER
	The path of the operation
plUseBeforeImage	LOGICAL
	Logical value indicating the use of before image
pcType	CHARACTER
	The type of the operation
pcVerb	CHARACTER
	The http verb of the operation
pcParameterNames	CHARACTER
	The names of the operation parameters
pcParameterTypes	CHARACTER
	The types of the operation parameters
Returns	Progress.Json.ObjectModel.JsonObject
	The JsonObject representing an operation

Top

PUBLIC Progress.Json.ObjectModel.JsonArray GetOperations (character, character)

Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12

Purpose:	Returns the Array of REST Operations for the given Dataset Name
Notes:

Parameters:
pcEntityName	CHARACTER
	The name of the business entity
pcDatasetName	CHARACTER
	The name of the ProDataset parameter
Returns	Progress.Json.ObjectModel.JsonArray
	The JsonArray representing the operations

Top

PUBLIC Progress.Json.ObjectModel.JsonArray GetOperations (IBusinessTaskCatalogData)

Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12

Purpose:	Returns the Array of REST Operations for the given Dataset Name
Notes:

Parameters:
poBusinessTask	Consultingwerk.OERA.IBusinessTaskCatalogData
	The IBusinessTaskCatalogData instance that describes the operations
Returns	Progress.Json.ObjectModel.JsonArray
	The JsonArray representing the operations

Top

PUBLIC Progress.Json.ObjectModel.JsonArray GetRelations (handle)

Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12

Purpose:	Returns the JSON Schema description of the Relations for the ProDataset
Notes:

Parameters:
phDataset	HANDLE
	The ProDataset to return the schema for
Returns	Progress.Json.ObjectModel.JsonArray
	The JsonObject representing the relations

Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetResource (character, handle)

Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12

Purpose:	Returns a Resource instance
Notes:

Parameters:
pcEntityName	CHARACTER
	The name of the Business Entity
phDataset	HANDLE
	The dataset to return
Returns	Progress.Json.ObjectModel.JsonObject
	The JsonObject representing the resources

Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetResource (IBusinessTaskCatalogData, HandleList)

Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12

Purpose:	Returns a Resource instance
Notes:

Parameters:
poBusinessTask	Consultingwerk.OERA.IBusinessTaskCatalogData
	The reference to the IBusinessTaskCatalogData
poDatasets	HandleList
	The datasets to add to the catalog
Returns	Progress.Json.ObjectModel.JsonObject
	The JsonObject representing the service

Top

PUBLIC Progress.Json.ObjectModel.JsonObject GetSchema (handle)

Overrides Consultingwerk.OERA.JsdoGenericService.CatalogV12:GetSchema (handle)

Purpose:	Returns the JSON Schema description for the ProDataset
Notes:

Parameters:
phDataset	HANDLE
	The ProDataset to return the schema for
Returns	Progress.Json.ObjectModel.JsonObject
	The JsonObject representing the schema

Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetService (character, RestServiceAddress, handle)

Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12

Purpose:	Returns a Service instance
Notes:

Parameters:
pcEntityName	CHARACTER
	The name of the Business Entity
poAddress	Consultingwerk.OERA.JsdoGenericService.RestServiceAddress
	The RestServiceAddress to include in the catalog output
phDataset	HANDLE
	The dataset to return
Returns	Progress.Json.ObjectModel.JsonObject
	The JsonObject representing the service

Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetService (IBusinessTaskCatalogData, RestServiceAddress, HandleList)

Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12

Purpose:	Returns a Service instance
Notes:

Parameters:
poBusinessTask	Consultingwerk.OERA.IBusinessTaskCatalogData
	The reference to the IBusinessTaskCatalogData
poAddress	Consultingwerk.OERA.JsdoGenericService.RestServiceAddress
	The RestServiceAddress to include in the catalog output
poDatasets	HandleList
	The datasets to add to the catalog
Returns	Progress.Json.ObjectModel.JsonObject
	The JsonObject representing the service

Top

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

Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12

Purpose:	Returns the JSON Object with the information about the restrictions
Notes:

Parameters:
pcEntityName	CHARACTER

Returns	Progress.Json.ObjectModel.JsonObject
	The JsonObject representing the Business Entities restrictions

Constructor Detail

Top

PUBLIC CatalogV14 ()

Purpose:	Constructor for the CatalogV14 class
Notes:

Property Detail

Top

PUBLIC CHARACTER CatalogVersion

Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12

Returns	CHARACTER

Top

PROTECTED CHARACTER EntityName

Inherited from Consultingwerk.OERA.JsdoGenericService.CatalogV12

Returns	CHARACTER

info@consultingwerk.de http://www.consultingwerk.de 09.11.2024 18:38:19