Namespace: Consultingwerk.BusinessEntityDesigner.Services
Class 
BusinessEntityDesignerBusinessTask Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.OERA.BusinessTask
Consultingwerk.BusinessEntityDesigner.Services.BusinessEntityDesignerBusinessTask

Inherits: Consultingwerk.OERA.BusinessTask
Implements: Consultingwerk.OERA.IBusinessService, Consultingwerk.OERA.RestResource.ISupportsRestMethods

File:BusinessEntityDesignerBusinessTask
Purpose:Service Interface for Business Entity Designer for the Web
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sat Oct 05 17:58:16 CEST 2019

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



Top Method Summary
Options Name Purpose
+ Progress.Json.ObjectModel.JsonObject CreateDataRelation (dataset, CreateDataRelationRequest) Returns the properties for a new Data Relation
+ Consultingwerk.BusinessEntityDesigner.Services.GenerateCodeResponse GenerateCode (dataset, GenerateCodeRequest) Generates a Business Entity using the Business Entity Designer
# GenericStatusChandedHandler (IStatusManager, character) Event handler for the GenericStatusChanged event of the IStatusManager
+ Progress.Json.ObjectModel.JsonObject GetFieldValidationTypeDescriptor (CharacterHolder) Returns the type descriptor for a validation type
+ Progress.Json.ObjectModel.JsonArray GetFieldValidationTypes () Returns a JSON Array of Field Validation types
+ Progress.Json.ObjectModel.JsonArray GetFiles (CharacterHolder) Returns the list of .bedgm files
+ Progress.Json.ObjectModel.JsonArray GetRelatedTables (GetRelatedTablesRequest) Returns a list of related tables
+ Consultingwerk.OERA.RestResource.ListRestMethod GetRestMethods () Returns the list of supported rest adresses for methods to the caller
Inherited from Consultingwerk.OERA.BusinessTask
+ Progress.Json.ObjectModel.JsonArray GetRootFolders () Returns the list of root folders with .bedgm files
+ Progress.Json.ObjectModel.JsonObject GetSettings () Returns the list of root folders with .bedgm files
+ OpenFile (dataset, CharacterHolder) Returns the contents of a .bedgm files
+ Consultingwerk.OERA.RestResource.RestMethodResponse SaveFile (dataset, CharacterHolder) Saves a .bedgm file
# ScopedStatusChandedHandler (IStatusManager, character, character) Event handler for the ScopedStatusChanged event of the IStatusManager
+ Consultingwerk.BusinessEntityDesigner.Services.ValidateDesignResponse ValidateDesign (dataset, ValidateDesignRequest) Validates a Design


Method Detail
Top

PUBLIC Progress.Json.ObjectModel.JsonObject CreateDataRelation (dataset, CreateDataRelationRequest)
Purpose: Returns the properties for a new Data Relation
Notes:

Parameters:
dsBusinessEntity DATASET dsBusinessEntity
Dataset with Business Entity Model
poRequest Consultingwerk.BusinessEntityDesigner.CreateDataRelationRequest
The CreateDataRelationRequest with the data for this return
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject containing the Relation properties
Top

PUBLIC Consultingwerk.BusinessEntityDesigner.Services.GenerateCodeResponse GenerateCode (dataset, GenerateCodeRequest)
Purpose: Generates a Business Entity using the Business Entity Designer
Notes:

Parameters:
dsBusinessEntity DATASET dsBusinessEntity
INPUT-OUTPUT Dataset
poRequest Consultingwerk.BusinessEntityDesigner.Services.GenerateCodeRequest
The GenerateCodeRequest instance
Returns Consultingwerk.BusinessEntityDesigner.Services.GenerateCodeResponse
The GenerateCodeResponse instance with the method result
Top

PROTECTED GenericStatusChandedHandler (IStatusManager, character)
Purpose: Event handler for the GenericStatusChanged event of the IStatusManager
Notes:

Parameters:
sender Consultingwerk.Framework.IStatusManager
The IStatusManager that raised this event
pcStatus CHARACTER
The generic status value
Top

PUBLIC Progress.Json.ObjectModel.JsonObject GetFieldValidationTypeDescriptor (CharacterHolder)
Purpose: Returns the type descriptor for a validation type
Notes:

Parameters:
poType Consultingwerk.CharacterHolder
The CharacterHolder with the type name of the validation type
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject representing the type descriptor
Top

PUBLIC Progress.Json.ObjectModel.JsonArray GetFieldValidationTypes ()
Purpose: Returns a JSON Array of Field Validation types
Notes:

Returns Progress.Json.ObjectModel.JsonArray
The JSON Array of field validation types
Top

PUBLIC Progress.Json.ObjectModel.JsonArray GetFiles (CharacterHolder)
Purpose: Returns the list of .bedgm files
Notes:

Parameters:
poPath Consultingwerk.CharacterHolder
The CharacterHolder with the name of the root path
Returns Progress.Json.ObjectModel.JsonArray
The JsonArray with the list of file names
Top

PUBLIC Progress.Json.ObjectModel.JsonArray GetRelatedTables (GetRelatedTablesRequest)
Purpose: Returns a list of related tables
Notes:

Parameters:
poRequest Consultingwerk.BusinessEntityDesigner.Services.GetRelatedTablesRequest
The GetRelatedTablesRequest instance
Returns Progress.Json.ObjectModel.JsonArray
The JsonArray with the related tables
Top

PUBLIC Consultingwerk.OERA.RestResource.ListRestMethod GetRestMethods ()
Inherited from Consultingwerk.OERA.BusinessTask
Purpose: Returns the list of supported rest adresses for methods
to the caller
Notes:

Returns Consultingwerk.OERA.RestResource.ListRestMethod
The list of supported rest methods to the caller
Top

PUBLIC Progress.Json.ObjectModel.JsonArray GetRootFolders ()
Purpose: Returns the list of root folders with .bedgm files
Notes:

Returns Progress.Json.ObjectModel.JsonArray
The JsonArray with the list of root folders
Top

PUBLIC Progress.Json.ObjectModel.JsonObject GetSettings ()
Purpose: Returns the list of root folders with .bedgm files
Notes:

Returns Progress.Json.ObjectModel.JsonObject
The JsonArray with the list of root folders
Top

PUBLIC OpenFile (dataset, CharacterHolder)
Purpose: Returns the contents of a .bedgm files
Notes:

Parameters:
dsBusinessEntity DATASET dsBusinessEntity
INPUT-OUTPUT Dataset
poFileName Consultingwerk.CharacterHolder
The CharacterHolder with the name of the .bedgm file
Top

PUBLIC Consultingwerk.OERA.RestResource.RestMethodResponse SaveFile (dataset, CharacterHolder)
Purpose: Saves a .bedgm file
Notes:

Parameters:
dsBusinessEntity DATASET dsBusinessEntity
INPUT-OUTPUT Dataset
poFileName Consultingwerk.CharacterHolder
The CharacterHolder with the name of the .bedgm file
Returns Consultingwerk.OERA.RestResource.RestMethodResponse
The RestMethodResponse with the response data
Top

PROTECTED ScopedStatusChandedHandler (IStatusManager, character, character)
Purpose: Event handler for the ScopedStatusChanged event of the IStatusManager
Notes:

Parameters:
sender Consultingwerk.Framework.IStatusManager
The IStatusManager that raised this event
pcStatus CHARACTER
The generic status value
pcScope CHARACTER
The name of the scope
Top

PUBLIC Consultingwerk.BusinessEntityDesigner.Services.ValidateDesignResponse ValidateDesign (dataset, ValidateDesignRequest)
Purpose: Validates a Design
Notes:

Parameters:
dsBusinessEntity DATASET dsBusinessEntity
INPUT-OUTPUT Dataset
poRequest Consultingwerk.BusinessEntityDesigner.Services.ValidateDesignRequest
The ValidateDesignRequest (answered questions)
Returns Consultingwerk.BusinessEntityDesigner.Services.ValidateDesignResponse
The ValidateDesignRequest (unanswered questions)


ProDataset Detail

ProDataset dsBusinessEntity

Member tables: eBusinessEntity, eDataRelation, eDataRelationProperties, eTable, eField, eFieldProperties, eIndex, eIndexProperties, eTableProperties, eBusinessEntityProperties


Temp-Table Detail

Temp-Table eBusinessEntity

Defined in:

Temp-Table eBusinessEntityProperties

Defined in:

Temp-Table eDataRelation

Defined in:

Temp-Table eDataRelationProperties

Defined in:

Temp-Table eField

Defined in:

Temp-Table eFieldProperties

Defined in:

Temp-Table eIndex

Defined in:

Temp-Table eIndexProperties

Defined in:

Temp-Table eTable

Defined in:

Temp-Table eTableProperties

Defined in:


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       15.04.2024 05:49:46