Namespace: Consultingwerk.SmartFramework.Menu
Class 
MenuBusinessEntity Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.OERA.BusinessEntity
Consultingwerk.SmartFramework.SmartBusinessEntity
Consultingwerk.SmartFramework.Menu.MenuBusinessEntity

Inherits: Consultingwerk.SmartFramework.SmartBusinessEntity
Implements: Ccs.BusinessLogic.IBusinessEntity, Ccs.BusinessLogic.IUpdatableBusinessEntity, Consultingwerk.OERA.IBusinessEntity, Consultingwerk.OERA.IBusinessService, Consultingwerk.OERA.IFetchDataByReference, Consultingwerk.OERA.IHasContextID, IProvidesBusinessEntityDescriptor

File:MenuBusinessEntity
Purpose:Business Entity for Menu
Author(s):Marko Rüterbories / Consultingwerk Ltd.
Created:11.10.2012 01:41:25

Consultingwerk.SmartFramework.Menu.MenuBusinessEntity
Consultingwerk.SmartFramework.Menu.MenuBusinessEntity

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



Top Method Summary
Options Name Purpose
+ CanFind (dataset-handle, CanFindParameter) Returns a TRUE value if a record is found that meets the specified FIND criteria; otherwise it returns FALSE. CAN-FIND does not make the record available to the Business Entity or it's caller.
Inherited from Consultingwerk.OERA.BusinessEntity
+ LOGICAL CanFind (character, character) Returns a TRUE value if a record is found that meets the specified FIND criteria; otherwise it returns FALSE. CAN-FIND does not make the record available to the Business Entity or it's caller.
Inherited from Consultingwerk.OERA.BusinessEntity
+ CountResultRecords (dataset-handle, ICountRecordsRequest) Counts the number of results of the query
Inherited from Consultingwerk.OERA.BusinessEntity
+ DeleteMenuItem (character) Deletes a menu item and it's children
# DestroyDataAccessObject () Unloads the DataAccess object
Inherited from Consultingwerk.OERA.BusinessEntity
+ dispose () Destroy/Shutdown/Anti-Initializer
Inherited from Consultingwerk.OERA.BusinessEntity
# FetchChildTableRecords (handle) Populates records in the child table identified by the buffer handle of the child table
Inherited from Consultingwerk.OERA.BusinessEntity
+ FetchData (IFetchDataRequest) Fetch data from the Data Access object
Inherited from Consultingwerk.OERA.BusinessEntity
# FetchData (IFetchDataRequest, handle) Fetch data from the Data Access object
Inherited from Consultingwerk.OERA.BusinessEntity
+ F FetchData (IFetchDataRequest, dataset-handle) Fetch data and/or definitions
Inherited from Consultingwerk.OERA.BusinessEntity
+ FetchDataByKeyTable (dataset-handle, IFetchDataByKeyTableParameter) Allows retrieve multiple DB records from a Business Entity based on a temp-table with key values
Inherited from Consultingwerk.OERA.BusinessEntity
+ F FetchDataByReference (IFetchDataRequest, dataset) Fetch data from the Data Access object
+ FetchDataset (dataset-handle) Creates and returns an empty dataset to the caller
Inherited from Consultingwerk.OERA.BusinessEntity
# FetchRelatedRecords (handle, character) Populates records in the named tables based on their relation to the provided record
Inherited from Consultingwerk.OERA.BusinessEntity
+ GetBusinessEntityDescriptor (dataset-handle, GetBusinessEntityDescriptorParameter) Returns the Business Entity Descriptor for this Business Entity
Inherited from Consultingwerk.OERA.BusinessEntity
+ IGetDataResponse getData (IGetDataRequest, dataset-handle) Performs a read request
Inherited from Consultingwerk.OERA.BusinessEntity
# Consultingwerk.OERA.IDataAccess GetDataAccessObject () Returns the reference to the DataAccess Object
Inherited from Consultingwerk.OERA.BusinessEntity
+ getDataset (dataset-handle) Returns an empty instance of the primary ProDataset to the caller
Inherited from Consultingwerk.OERA.BusinessEntity
+ GetInitialValues (dataset-handle, GetInitialValuesParameter) Returns a dataset with one record containing the initial values
Inherited from Consultingwerk.OERA.BusinessEntity
+ GetMenuItems (dataset, CharacterHolder) Returns Menu Items based on a list of FunctionGuids to the client
+ GetMenus (dataset, CharacterHolder) Returns the eSmartMenu records for a comma delimited list of MenuGuid's
+ GetMenusForGroups (dataset, CharacterHolder) Returns the eSmartMenu records for a comma delimited list of user group guids
+ GetMenuStructure (dataset-handle, IGetMenuStructureParameter) Returns a recursive menu structure
# GetMenuStructure (handle, handle, character, integer, integer, logical) Returns one level of menu data
+ ListRestAddress GetRestAddresses () Returns the list of supported rest adresses to the caller
Inherited from Consultingwerk.OERA.BusinessEntity
+ ListRestMethod GetRestMethods () Returns the list of supported rest adresses for methods to the caller
Inherited from Consultingwerk.OERA.BusinessEntity
+ IGetResultCountResponse getResultCount (IGetDataRequest) Returns the count of the total number of result records or a guess of the result count to the caller
Inherited from Consultingwerk.OERA.BusinessEntity
+ GetTopNavBuffers (dataset-handle, CharacterHolder) Populates the provided CharacterHolder with a comma-delimited list of the names of the dataset TOP-NAV-BUFFER's
Inherited from Consultingwerk.OERA.BusinessEntity
+ initialize () Initializer/Startup
Inherited from Consultingwerk.OERA.BusinessEntity
# InitializeDataAccessObject () Initializes the DataAcess Object
Overrides Consultingwerk.SmartFramework.SmartBusinessEntity:InitializeDataAccessObject ()
# InvokeReceiveData (RequestTypeEnum, Object) Invokes the ReceiveDataMethod
Inherited from Consultingwerk.OERA.BusinessEntity
+ MoveMenuStructure (dataset-handle, MoveMenuStructureParameter) Moves a Menu Structure item
# LOGICAL PopulateFromPartialBuffer (handle) Populates a single ProDataset record from the partial record to the complete record
Inherited from Consultingwerk.OERA.BusinessEntity
# PopulateMenuStyle (handle) Populates the Menu Style in the dataset
# PopulatePartialBuffer (handle) Populates a single ProDataset record from the partial record to the complete record
Inherited from Consultingwerk.OERA.BusinessEntity
# ReceiveData () Provides a hook to modify data in the ProDataset after Read and Update operations (i.e. population of aggregated values)
Overrides Consultingwerk.OERA.BusinessEntity:ReceiveData ()
+ SaveChanges () Saves changes using the DataAccess object
Inherited from Consultingwerk.OERA.BusinessEntity
+ F SaveChanges (dataset-handle) Saves changes
Inherited from Consultingwerk.OERA.BusinessEntity
+ F SaveChanges (dataset-handle, Object) Saves changes
Inherited from Consultingwerk.OERA.BusinessEntity
+ SavePartialChanges (dataset-handle, Object) Saves partial changes to the Busiuness Entity Dataset
Inherited from Consultingwerk.OERA.BusinessEntity
+ CHARACTER SourceTable (character) Returns the name of the source (database) table for a ProDataset table name
Inherited from Consultingwerk.SmartFramework.SmartBusinessEntity
# CHARACTER UniqueFindPredicateWithValueBuffer (handle, handle, character) Builds a unique find predicate for a prodataset buffer (based on an unique index).
Inherited from Consultingwerk.OERA.BusinessEntity
+ Progress.Lang.Object updateData (dataset-handle, IUpdateDataRequest) Stores data modifications in the persistent storage (typically a database)
Inherited from Consultingwerk.OERA.BusinessEntity
# ValidateAddOnlyColumns (handle, character) Performs AddOnly validation for a list of columns
Inherited from Consultingwerk.OERA.BusinessEntity
# ValidateBasedOnBusinessEntityDescriptor () Performs validation based on the Business Entity Descriptor properties
Inherited from Consultingwerk.OERA.BusinessEntity
# ValidateData () Provides a hook for high level data validation before Update operations
Overrides Consultingwerk.OERA.BusinessEntity:ValidateData ()
+ ValidateData (dataset-handle, IValidateDataContext) Provides a client callable method for data validation
Inherited from Consultingwerk.OERA.BusinessEntity
# ValidateMandatoryColumns (handle, character) Performs Mandatory validation for a list of columns
Inherited from Consultingwerk.OERA.BusinessEntity
+ ValidatePartialData (dataset-handle, IValidateDataContext) Provides a client callable method for partial data validation
Inherited from Consultingwerk.OERA.BusinessEntity
# ValidateReadOnlyColumns (handle, character) Performs ReadOnly validation for a list of columns
Inherited from Consultingwerk.OERA.BusinessEntity

Top Constructor Summary
Options Name Purpose
+ MenuBusinessEntity () Constructor of the MenuBusinessEntity class

Top Property Summary
Options Name Purpose
+ CHARACTER ContextID
Inherited from Consultingwerk.OERA.BusinessEntity
+ CHARACTER DataAccessName
Inherited from Consultingwerk.OERA.BusinessEntity
+ Consultingwerk.OERA.IDataAccess DataAccessObject
Inherited from Consultingwerk.OERA.BusinessEntity
+ HANDLE DatasetHandle
Inherited from Consultingwerk.OERA.BusinessEntity
# Consultingwerk.OERA.IFetchDataRequest FetchDataRequest
Inherited from Consultingwerk.OERA.BusinessEntity
+ Consultingwerk.OERA.Enum.RequestTypeEnum RequestType
Inherited from Consultingwerk.OERA.BusinessEntity
# Progress.Lang.Object SaveChangesParameter
Inherited from Consultingwerk.OERA.BusinessEntity
+ LOGICAL TrackingChanges
Inherited from Consultingwerk.OERA.BusinessEntity
# Consultingwerk.OERA.IValidateDataContext ValidateDataContext
Inherited from Consultingwerk.OERA.BusinessEntity


Method Detail
Top

PUBLIC CanFind (dataset-handle, CanFindParameter)
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Returns a TRUE value if a record is found that meets the specified
FIND criteria; otherwise it returns FALSE. CAN-FIND does not make
the record available to the Business Entity or it's caller.
Notes: Invokable method
Result will be assigned to the Result property of the CanFindParameter
instance

Parameters:
phDataset DATASET-HANDLE
Not used, do not pass in a DATASET or DATASET-HANDLE
poParameter Consultingwerk.OERA.CanFindParameter
The CanFindParameter with the parameters for this call
Top

PUBLIC LOGICAL CanFind (character, character)
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Returns a TRUE value if a record is found that meets the specified
FIND criteria; otherwise it returns FALSE. CAN-FIND does not make
the record available to the Business Entity or it's caller.
Notes:

Parameters:
pcTableName CHARACTER
The name of the temp-table
pcFindString CHARACTER
The find string
Returns LOGICAL
Logical value indicating if the record can be found
Top

PUBLIC CountResultRecords (dataset-handle, ICountRecordsRequest)
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Counts the number of results of the query
Notes: Used by the Generic JSDO Service to support the Count feature
Supports STOP-AFTER: When STOP-AFTER occurs, the StopAfterNumResults
value of the parameter object is returns as the Results
https://consultingwerk.atlassian.net/wiki/spaces/SCL/pages/8094448/Generic+Service+Interface+for+JSDO+with+Kendo+UI+dialect#GenericServiceInterfaceforJSDOwithKendoUIdialect-ResourceCount //consultingwerk.atlassian.net/wiki/spaces/SCL/pages/8094448/Generic+Service+Interface+for+JSDO+with+Kendo+UI+dialect#GenericServiceInterfaceforJSDOwithKendoUIdialect-ResourceCount

Parameters:
phDataset DATASET-HANDLE
The dataset handle (not used)
poParameter Consultingwerk.OERA.ICountRecordsRequest
The CharacterHolder to receive the list of TOP-NAV-BUFFERS
Top

PUBLIC DeleteMenuItem (character)
Purpose: Deletes a menu item and it's children
Notes:

Parameters:
pcMenuGuid CHARACTER
The GUID of the menu item to delete
Top

PROTECTED DestroyDataAccessObject ()
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Unloads the DataAccess object
Notes:

Top

PUBLIC dispose ()
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Destroy/Shutdown/Anti-Initializer
Notes:

Top

PROTECTED FetchChildTableRecords (handle)
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Populates records in the child table identified by the buffer handle
of the child table
Notes: Calls into a second instance of the Business Entity and performs a
FetchDataRequest based on the current record in the parent buffer
Performs no action, when the Child table record for the parent is
already available

Parameters:
phChildBuffer HANDLE
The child buffer
Top

PUBLIC FetchData (IFetchDataRequest)
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Fetch data from the Data Access object
Notes:

Parameters:
poFetchDataRequest Consultingwerk.OERA.IFetchDataRequest
The IFetchDataRequest object with the parameters for this call
Top

PROTECTED FetchData (IFetchDataRequest, handle)
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Fetch data from the Data Access object
Notes: This variant of FetchData is used by strong-typed
methods in the actual Business Entity class and provides
the handle of a BY-REFERENCE DATASET Parameter received
from the caller (typically the Service Interface class)

Parameters:
poFetchDataRequest Consultingwerk.OERA.IFetchDataRequest
The IFetchDataRequest object with the parameters for this call
phDataset HANDLE
The handle of the DATASET received BY-REFERENCE from the caller
Top

PUBLIC FetchData (IFetchDataRequest, dataset-handle)
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Fetch data and/or definitions
Notes:

Parameters:
poFetchDataRequest Consultingwerk.OERA.IFetchDataRequest
The IFetchDataRequest object with the parameter for this call
phDataset DATASET-HANDLE
OUTPUT Dataset with the resulting data
Top

PUBLIC FetchDataByKeyTable (dataset-handle, IFetchDataByKeyTableParameter)
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Allows retrieve multiple DB records from a Business Entity based on
a temp-table with key values
Notes: Proxy method to calling the same method in the data access class
SCL-647

Parameters:
phDataset DATASET-HANDLE
INPUT-OUTPUT DATAEST-HANDLE, only used for OUTPUT of the resulting dataset
poParameter Consultingwerk.OERA.IFetchDataByKeyTableParameter
The IFetchDataByKeyTableParameter with the data for this call
Top

PUBLIC FetchDataByReference (IFetchDataRequest, dataset)
Purpose: Fetch data from the Data Access object
Notes:

Parameters:
poFetchDataRequest Consultingwerk.OERA.IFetchDataRequest
The IFetchDataRequest object with the parameters for this call
dsMenu DATASET dsMenu
The dataset, intended to by passed BY-REFERENCE
Top

PUBLIC FetchDataset (dataset-handle)
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Creates and returns an empty dataset to the caller
Notes: Useful for dynamic callers that need access to the dataset schema prior to calling FetchData

Parameters:
phDataset DATASET-HANDLE
OUTPUT Dataset with the resulting data
Top

PROTECTED FetchRelatedRecords (handle, character)
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Populates records in the named tables based on their relation to
the provided record
Notes:

Parameters:
phBufferHandle HANDLE
The source buffer handle
pcRelatedTables CHARACTER
Comma delimited list of temp-table names to populate
Top

PUBLIC GetBusinessEntityDescriptor (dataset-handle, GetBusinessEntityDescriptorParameter)
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Returns the Business Entity Descriptor for this Business Entity
Notes: Invokable Method
https://consultingwerk.atlassian.net/wiki/spaces/SCL/pages/8094518/Business+Entity+Descriptor //consultingwerk.atlassian.net/wiki/spaces/SCL/pages/8094518/Business+Entity+Descriptor

Parameters:
phDataset DATASET-HANDLE
The dataset of the Business Entity
poParameter GetBusinessEntityDescriptorParameter
The GetBusinessEntityDescriptorParameter with the data for this call
Top

PUBLIC IGetDataResponse getData (IGetDataRequest, dataset-handle)
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Performs a read request
Notes:

Parameters:
poRequest IGetDataRequest
The IGetDataRequest instance with the getData request parameters
phDataset DATASET-HANDLE
OUTPUT Dataset
Returns IGetDataResponse
The IGetDataResponse instance
Top

PROTECTED Consultingwerk.OERA.IDataAccess GetDataAccessObject ()
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Returns the reference to the DataAccess Object
Notes: If THIS-OBJECT:DataAccessObject is not valid, this
method will invoke InitializeDataAccessObject before
returning the reference

Returns Consultingwerk.OERA.IDataAccess
The reference to the Data Access object
Top

PUBLIC getDataset (dataset-handle)
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Returns an empty instance of the primary ProDataset to the caller
Notes: Used for catalog generation or initialization of dynamic user
interfaces etc.

Parameters:
phDataset DATASET-HANDLE
OUTPUT Dataset (not intended to be called BY-REFERENCE)
Top

PUBLIC GetInitialValues (dataset-handle, GetInitialValuesParameter)
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Returns a dataset with one record containing the initial values
Notes: Can be overridden in Business Entity implementations to provide
dynamic initial values. The base class implementation will return
the buffer fields initial values. The parameter object's TableNames
is a comma-delimited list. The parameter object's ForeignKeyFields
property is a character array (one element per table) of comma delimited
lists of the provided foreign field names. The foreing field values is a
character array (one element per table) of CHR(1) delimited field
values

Parameters:
phDataset DATASET-HANDLE
Used to return the dataset
poParameter Consultingwerk.OERA.GetInitialValuesParameter
The GetInitialValuesParameter instance with the parameters for this call
Top

PUBLIC GetMenuItems (dataset, CharacterHolder)
Purpose: Returns Menu Items based on a list of FunctionGuids to the client
Notes:

Parameters:
dsMenu DATASET dsMenu
The dataset with the Menu Structure
poKeys Consultingwerk.CharacterHolder
The CharacterHolder instance with the comma delimited list of Menu Function Keys, CHR(1) delimited
Top

PUBLIC GetMenus (dataset, CharacterHolder)
Purpose: Returns the eSmartMenu records for a comma delimited list of MenuGuid's
Notes:

Parameters:
dsMenu DATASET dsMenu
The dataset with the Menu Structure
poMenuGuids Consultingwerk.CharacterHolder
The CharacterHolder instance with the comma delimited list of MenuGuid's
Top

PUBLIC GetMenusForGroups (dataset, CharacterHolder)
Purpose: Returns the eSmartMenu records for a comma delimited list of user group
guids
Notes:

Parameters:
dsMenu DATASET dsMenu
The dataset with the Menu Structure
poGroups Consultingwerk.CharacterHolder
The CharacterHolder class that contains the comma delimited list of user groups
Top

PUBLIC GetMenuStructure (dataset-handle, IGetMenuStructureParameter)
Purpose: Returns a recursive menu structure
Notes:

Parameters:
phDataset DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE
poGetMenuStructureParameter Consultingwerk.SmartFramework.IGetMenuStructureParameter
Top

PROTECTED GetMenuStructure (handle, handle, character, integer, integer, logical)
Purpose: Returns one level of menu data
Notes:

Parameters:
phBuffer HANDLE
The target buffer (eSmartMenu)
phFunctionBuffer HANDLE
The target buffer (eSmartFunction), only populated when plIncludeMenuFunction = TRUE
pcParentMenuKey CHARACTER
The current parent menu key
piNumberOfLevels INTEGER
The maximum number of levels to return (limit recursion)
piCurrentLevel INTEGER
The current level (recursion)
plIncludeMenuFunction LOGICAL
Logical value indicating if the menu function table should be populated as well
Top

PUBLIC ListRestAddress GetRestAddresses ()
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Returns the list of supported rest adresses to the caller
Notes:

Returns ListRestAddress
The list of supported rest adresses to the caller
Top

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

Returns ListRestMethod
The list of supported rest methods to the caller
Top

PUBLIC IGetResultCountResponse getResultCount (IGetDataRequest)
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Returns the count of the total number of result records or a guess
of the result count to the caller
Notes:

Parameters:
poRequest IGetDataRequest
The IGetDataRequest instance with the getResultCount request parameters
Returns IGetResultCountResponse
The IGetResultCountResponse instance
Top

PUBLIC GetTopNavBuffers (dataset-handle, CharacterHolder)
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Populates the provided CharacterHolder with a comma-delimited list
of the names of the dataset TOP-NAV-BUFFER's
Notes:

Parameters:
phDataset DATASET-HANDLE
The dataset handle (not used)
poParameter Consultingwerk.CharacterHolder
The CharacterHolder to receive the list of TOP-NAV-BUFFERS
Top

PUBLIC initialize ()
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Initializer/Startup
Notes:

Top

PROTECTED InitializeDataAccessObject ()
Overrides Consultingwerk.SmartFramework.SmartBusinessEntity:InitializeDataAccessObject ()
Purpose: Initializes the DataAcess Object
Notes: Uses the DataAccessName property

Top

PROTECTED InvokeReceiveData (RequestTypeEnum, Object)
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Invokes the ReceiveDataMethod
Notes: This method is on purpose overridable. This method allows to
control centrally if ReceiveData should be called or not by
deciding if SUPER:InvokeReceiveData (poRequestType, poRequest)
is called or not

Parameters:
poRequestType RequestTypeEnum
The RequestTypeEnum describing the type of the current call
poRequest Progress.Lang.Object
The request argument, IFetchDataRequest, IFetchDataByKeyTableRequest or the parameter argument passed to the SaveChanges methods
Top

PUBLIC MoveMenuStructure (dataset-handle, MoveMenuStructureParameter)
Purpose: Moves a Menu Structure item
Notes: Validates that we don't move a structure into a child or grand child structure

Parameters:
phDataset DATASET-HANDLE
DATASET-HANDLE, not used
poParameter Consultingwerk.SmartFramework.Menu.MoveMenuStructureParameter
The MoveMenuStructureParameter with the data for this call
Top

PROTECTED LOGICAL PopulateFromPartialBuffer (handle)
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Populates a single ProDataset record from the partial record to the complete
record
Notes: Used during SavePartialChanges and ValidatePartialData before SaveChanges
(for a single record) or ValidateData are called

Parameters:
phPartialBuffer HANDLE
The buffer of the partial dataset to use as the source
Returns LOGICAL
Logical value indicating if the operation was successful
Top

PROTECTED PopulateMenuStyle (handle)
Purpose: Populates the Menu Style in the dataset
Notes:

Parameters:
phDataset HANDLE
The dataset that contains the eSmartMenu records
Top

PROTECTED PopulatePartialBuffer (handle)
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Populates a single ProDataset record from the partial record to the complete
record
Notes: Used during SavePartialChanges and ValidatePartialData before SaveChanges
(for a single record) or ValidateData are called

Parameters:
phPartialBuffer HANDLE
The buffer of the partial dataset to use as the source
Top

PROTECTED ReceiveData ()
Overrides Consultingwerk.OERA.BusinessEntity:ReceiveData ()
Purpose: Provides a hook to modify data in the ProDataset after Read and
Update operations (i.e. population of aggregated values)
Notes: Invoked during FetchData () and SaveChanges ()

Top

PUBLIC SaveChanges ()
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Saves changes using the DataAccess object
Notes: This method saves changes contained in the dataset currently present
in the Business Entity

Top

PUBLIC SaveChanges (dataset-handle)
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Saves changes
Notes: This method is called from consumers of the Business Entity and
receives the dataset. It calls into the SaveChanges() method with no
parameters after the internal dataset has been set
This method is called by the ServiceInterface when no parameter object
has been passed in

Parameters:
phDataset DATASET-HANDLE
INPUT-OUTPUT Dataset with changes
Top

PUBLIC SaveChanges (dataset-handle, Object)
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Saves changes
Notes: This method is called from consumers of the Business Entity and
receives the dataset. It calls into the SaveChanges() method with no
parameters after the internal dataset has been set
This method is called by the ServiceInterface when a parameter object
has been passed in. The parameter object will be accessible from within
the business entity using the protected property SaveChangesParameter

Parameters:
phDataset DATASET-HANDLE
INPUT-OUTPUT Dataset with changes
poParameter Progress.Lang.Object
Optional Parameter object for the SaveChanges method
Top

PUBLIC SavePartialChanges (dataset-handle, Object)
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Saves partial changes to the Busiuness Entity Dataset
Notes: Saves only those fields from the provided Dataset. Does fetch the
complete dataset first, then applies changes from the provided
dataset to the complete dataset and saves this using SaveChanges.
Relies on ROW-STATE in the partial dataset as well! A seperate method
may be added in the future, that only expects current values from the
passed in ProDataset
When multiple records are provided in the partial dataset, currently
each record is processed alone
For simplicity of the partial dataset, we do not expect this dataset to
have indexes defined. However, we do expect that the partial dataset
contains the columns of the primary unique key of the business entity
dataset columns
Flow of actions:
- Fetch the whole Dataset Records
- Manipulate the "before"
- Manipulate the "after"
- SaveChanges()
- Transfer ERROR, ERROR-STRING attributes
- Return updated partial records to the caller
SCL-987

Parameters:
phDataset DATASET-HANDLE
INPUT-OUTPUT Dataset with changes
poParameter Progress.Lang.Object
Optional Parameter object for the SavePartialChanges method (BusinessEntity:SaveChangesParameter)
Top

PUBLIC CHARACTER SourceTable (character)
Inherited from Consultingwerk.SmartFramework.SmartBusinessEntity
Purpose: Returns the name of the source (database) table for a ProDataset
table name
Notes:

Parameters:
pcTempTableName CHARACTER
The temp-table buffer name to return the source table for
Returns CHARACTER
The database table name of the source table
Top

PROTECTED CHARACTER UniqueFindPredicateWithValueBuffer (handle, handle, character)
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Builds a unique find predicate for a prodataset buffer (based on an
unique index).
Notes: Based on BufferHelper:UniqueFindPredicateWithValueBuffer. Called from
SavePartialChanges. Extracted from SavePartialChanges to allow injecting
missing key field values (e.g. tenant related fields) by overriding
this method.

Parameters:
phBuffer HANDLE
The Business Entity ProDataset member buffer
phPartialBuffer HANDLE
The buffer of the partial dataset, values will be used from it's before-buffer
pcBufferName CHARACTER
The name of the buffer for the find string
Returns CHARACTER
The unique find predicate used to locate the ProDataset buffer for the partial update
Top

PUBLIC Progress.Lang.Object updateData (dataset-handle, IUpdateDataRequest)
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Stores data modifications in the persistent storage (typically a
database)
Notes: The output dataset will contain validation error messages in the
ERROR-STRING attributes of the record buffers. Records with Errors
will also have the ERROR attribute set to TRUE. When at least a single
record has a validation error, the ERROR attribute of the ProDataset
is assigned to TRUE as well

Parameters:
phDataset DATASET-HANDLE
INPUT-OUTPUT Dataset containing modified records to be processed (should be passed BY-REFERENCE)
poUpdateDataRequest IUpdateDataRequest
The optional request object that allows to provide custom instructions to the method
Returns Progress.Lang.Object
An optional response object returned by the method
Top

PROTECTED ValidateAddOnlyColumns (handle, character)
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Performs AddOnly validation for a list of columns
Notes:

Parameters:
phBuffer HANDLE
The handle of the buffer to validate
pcColumns CHARACTER
The list of columns to validate
Top

PROTECTED ValidateBasedOnBusinessEntityDescriptor ()
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Performs validation based on the Business Entity Descriptor
properties
Notes:

Top

PROTECTED ValidateData ()
Overrides Consultingwerk.OERA.BusinessEntity:ValidateData ()
Purpose: Provides a hook for high level data validation before Update
operations
Notes: Invoked during SaveChanges (). When the ERROR flag of the ProDataset
is set, the Update operation will be cancelled before writing back
the data to the database using the DataAccess object

Top

PUBLIC ValidateData (dataset-handle, IValidateDataContext)
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Provides a client callable method for data validation
Notes: Invokes ValidateData(), but not linked to any SaveChanges invokation
The poContext parameter is available during the method execution through
the ValidateDataContext property
See SCL-1030

Parameters:
phDataset DATASET-HANDLE
The DATASET-HANDLE with the data to validate
poContext Consultingwerk.OERA.IValidateDataContext
The IValidateDataContext instance with the context for this call
Top

PROTECTED ValidateMandatoryColumns (handle, character)
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Performs Mandatory validation for a list of columns
Notes:

Parameters:
phBuffer HANDLE
The handle of the buffer to validate
pcColumns CHARACTER
The list of columns to validate
Top

PUBLIC ValidatePartialData (dataset-handle, IValidateDataContext)
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Provides a client callable method for partial data validation
Notes: Invokes ValidateData(), but not linked to any SaveChanges invokation
The poContext parameter is available during the method execution through
the ValidateDataContext property
See SCL-1030, SCL-1034

Parameters:
phDataset DATASET-HANDLE
The DATASET-HANDLE with the data to validate
poContext Consultingwerk.OERA.IValidateDataContext
The IValidateDataContext instance with the context for this call
Top

PROTECTED ValidateReadOnlyColumns (handle, character)
Inherited from Consultingwerk.OERA.BusinessEntity
Purpose: Performs ReadOnly validation for a list of columns
Notes: ReadOnly columns may not be updated on Add and Update

Parameters:
phBuffer HANDLE
The handle of the buffer to validate
pcColumns CHARACTER
The list of columns to validate


Constructor Detail
Top

PUBLIC MenuBusinessEntity ()
Purpose: Constructor of the MenuBusinessEntity class
Notes: Passes the handle of the dataset instance to the base class and
sets the default DataAccessName



Property Detail
Top

PUBLIC CHARACTER ContextID
Inherited from Consultingwerk.OERA.BusinessEntity

Returns CHARACTER
Top

PUBLIC CHARACTER DataAccessName
Inherited from Consultingwerk.OERA.BusinessEntity

Returns CHARACTER
Top

PUBLIC Consultingwerk.OERA.IDataAccess DataAccessObject
Inherited from Consultingwerk.OERA.BusinessEntity

Returns Consultingwerk.OERA.IDataAccess
Top

PUBLIC HANDLE DatasetHandle
Inherited from Consultingwerk.OERA.BusinessEntity

Returns HANDLE
Top

PROTECTED Consultingwerk.OERA.IFetchDataRequest FetchDataRequest
Inherited from Consultingwerk.OERA.BusinessEntity

Returns Consultingwerk.OERA.IFetchDataRequest
Top

PUBLIC Consultingwerk.OERA.Enum.RequestTypeEnum RequestType
Inherited from Consultingwerk.OERA.BusinessEntity

Returns Consultingwerk.OERA.Enum.RequestTypeEnum
Top

PROTECTED Progress.Lang.Object SaveChangesParameter
Inherited from Consultingwerk.OERA.BusinessEntity

Returns Progress.Lang.Object
Top

PUBLIC LOGICAL TrackingChanges
Inherited from Consultingwerk.OERA.BusinessEntity

Returns LOGICAL
Top

PROTECTED Consultingwerk.OERA.IValidateDataContext ValidateDataContext
Inherited from Consultingwerk.OERA.BusinessEntity

Returns Consultingwerk.OERA.IValidateDataContext


©2006-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       04.02.2020 23:21:41