Consultingwerk.OERA.BusinessEntity - SmartComponent Library

Namespace:

Consultingwerk.OERA

Class

BusinessEntity

Parent classes:

Progress.Lang.Object

Consultingwerk.OERA.BusinessEntity

Inherits:

Progress.Lang.Object

Implements:

Ccs.BusinessLogic.IBusinessEntity, Ccs.BusinessLogic.IUpdatableBusinessEntity, Consultingwerk.OERA.IBusinessEntity, Consultingwerk.OERA.IBusinessService, Consultingwerk.OERA.IHasContextID, Consultingwerk.OERA.BusinessEntityDescriptor.IProvidesBusinessEntityDescriptor, Consultingwerk.OERA.IProvidesDatasetModel, Consultingwerk.OERA.RestResource.ISupportsETagValue, Consultingwerk.OERA.ISupportsResetState, Consultingwerk.OERA.ISupportsStaticQueryRequests

Inherited by:

ABSTRACT

Top Method Summary

Options	Name	Purpose
	AddETagFieldValue (JsonObject, character, handle, integer)	Adds the value of a buffer field to the JSON object used for the ETag value computation
	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.
	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.
	CountResultRecords (dataset-handle, ICountRecordsRequest)	Counts the number of results of the query
	INT64 CountResultRecords (ICountRecordsRequest)	Counts the number of results of the query
	DestroyDataAccessObject ()	Unloads the DataAccess object
	dispose ()	Destroy/Shutdown/Anti-Initializer
	FetchChildTableRecords (handle)	Populates records in the child table identified by the buffer handle of the child table
	FetchData (IFetchDataRequest)	Fetch data from the Data Access object
	FetchData (IFetchDataRequest, handle)	Fetch data from the Data Access object
F	FetchData (IFetchDataRequest, dataset-handle)	Fetch data and/or definitions
	FetchDataByKeyTable (dataset-handle, IFetchDataByKeyTableParameter)	Supports retrieve multiple DB records from a Business Entity based on a temp-table with key values
F	FetchDataByKeyTable (IFetchDataByKeyTableParameter, handle)	Fetch data from the Data Access object
	FetchDataByKeyValues (dataset-handle, FetchDataByKeysParameter)	Allows retrieve multiple DB records from a Business Entity based on extents of key values for one or more fields
F	FetchDataByKeyValues (FetchDataByKeysParameter, handle)	Fetch data from the Data Access object
	FetchDataByStaticQuery (dataset-handle, IFetchDataByStaticQueryRequest)	Retrieves data using a static query.
F	FetchDataByStaticQuery (IFetchDataByStaticQueryRequest, handle)	Retrieves data using a static query.
	FetchDataByTempTable (table-handle, IFetchDataByTempTableParameter, dataset-handle)	Supports retrieve multiple DB records from a Business Entity based on a join to an (external) temp-table
	FetchDataset (dataset-handle)	Creates and returns an empty dataset to the caller
	FetchRelatedRecords (handle, character)	Populates records in the named tables based on their relation to the provided record
	Consultingwerk.OERA.BusinessEntityDescriptor.IBusinessEntityDescriptor GetBusinessEntityDescriptor ()	Returns the Business Entity Descriptor for this Business Entity
	GetBusinessEntityDescriptor (dataset-handle, GetBusinessEntityDescriptorParameter)	Returns the Business Entity Descriptor for this Business Entity
	Ccs.BusinessLogic.IGetDataResponse getData (IGetDataRequest, dataset-handle)	Performs a read request
	Consultingwerk.OERA.IDataAccess GetDataAccessObject ()	Returns the reference to the DataAccess Object
	getDataset (dataset-handle)	Returns an empty instance of the primary ProDataset to the caller
	Progress.Lang.Class GetDatasetModelType ()	Returns the class reference of the DatasetModel type associated with this Business Entity
	CHARACTER GetETagValue (handle)	Returns the ETag value identifying the current version of the record in the given buffer
	GetInitialValues (dataset-handle, GetInitialValuesParameter)	Returns a dataset with one record containing the initial values
	Consultingwerk.OERA.RestResource.ListRestAddress GetRestAddresses ()	Returns the list of supported rest addresses to the caller
	Consultingwerk.OERA.RestResource.ListRestMethod GetRestMethods ()	Returns the list of supported rest addresses for methods to the caller
	Ccs.BusinessLogic.IGetResultCountResponse getResultCount (IGetDataRequest)	Returns the count of the total number of result records or a guess of the result count to the caller
	Consultingwerk.OERA.IFetchDataByStaticQueryRequest GetStaticQueryRequest (character, character, character, character)	Returns a strong-typed static query request instance for the given table and field combination
	Progress.Lang.Class GetTableModelType (character)	Returns the class reference of the TableModel type associated with this Business Entity
	CHARACTER GetTopNavBuffers ()	Returns the names of the dataset TOP-NAV-BUFFER's
	GetTopNavBuffers (dataset-handle, CharacterHolder)	Populates the provided CharacterHolder with a comma-delimited list of the names of the dataset TOP-NAV-BUFFER's
	initialize ()	Initializer/Startup
	InitializeDataAccessObject ()	Initializes the DataAccess Object
	InvokeReceiveData (RequestTypeEnum, Object)	Invokes the ReceiveDataMethod
	LOGICAL PopulateFromPartialBuffer (handle)	Populates a single ProDataset record from the partial record to the complete record
	PopulatePartialBuffer (handle)	Populates a single ProDataset record from the partial record to the complete record
A	ReceiveData ()	Provides a hook to modify data in the ProDataset after Read and Update operations (i.e. population of aggregated values)
	Consultingwerk.OERA.FetchDataRequest RequestForKeyField (character, character, character)	Factory method for the FetchDataRequest class
	Consultingwerk.OERA.FetchDataRequest RequestForKeyField (character, character, decimal)	Factory method for the FetchDataRequest class
	Consultingwerk.OERA.FetchDataRequest RequestForKeyField (character, character, integer)	Factory method for the FetchDataRequest class
	ResetState ()	Resets the state of the Business Entity by emptying temp-tables
	ResetState (handle, Object, character)	Resets the state of the Business Entity by emptying temp-tables
	RestoreDatasetHandle ()	Restores the DatasetHandle property value
	SaveChanges ()	Saves changes using the DataAccess object
F	SaveChanges (dataset-handle)	Saves changes
F	SaveChanges (dataset-handle, Object)	Saves changes
	SaveChanges (IActionType)	Saves changes with an Action Type instance
	SavePartialChanges (dataset-handle, Object)	Saves partial changes to the Business Entity Dataset
	CHARACTER SourceColumn (character, character)	Returns the database field name matching a temp-table field name
	Consultingwerk.CharacterHolder SourceColumn (SourceColumnRequest)	Returns the database field name matching a temp-table field name
	CHARACTER UniqueFindPredicateWithValueBuffer (handle, handle, character)	Builds a unique find predicate for a prodataset buffer (based on an unique index).
	Progress.Lang.Object updateData (dataset-handle, IUpdateDataRequest)	Stores data modifications in the persistent storage (typically a database)
	ValidateAddOnlyColumns (handle, character)	Performs AddOnly validation for a list of columns
	ValidateBasedOnBusinessEntityDescriptor ()	Performs validation based on the Business Entity Descriptor properties
A	ValidateData ()	Provides a hook for high level data validation before Update operations
	ValidateData (dataset-handle, IValidateDataContext)	Provides a client callable method for data validation
	ValidateMandatoryColumns (handle, character)	Performs Mandatory validation for a list of columns
	ValidatePartialData (dataset-handle, IValidateDataContext)	Provides a client callable method for partial data validation
	ValidateReadOnlyColumns (handle, character)	Performs ReadOnly validation for a list of columns

Top Constructor Summary

	Options	Name	Purpose
		BusinessEntity ()	Static Constructor for the BusinessEntity class
		BusinessEntity (handle)	Constructor for the BusinessEntity class

Top Property Summary

	Options	Name	Purpose
		Progress.Lang.Enum ActionType
		CHARACTER ContextID
		CHARACTER DataAccessName
		Consultingwerk.OERA.IDataAccess DataAccessObject
		HANDLE DatasetHandle
		Consultingwerk.OERA.IFetchDataRequest FetchDataRequest
		HANDLE OriginalDatasetHandle
		Consultingwerk.OERA.Enum.RequestTypeEnum RequestType
		Progress.Lang.Object SaveChangesParameter
		LOGICAL TrackingChanges
		Consultingwerk.OERA.IValidateDataContext ValidateDataContext

Method Detail

Top

AddETagFieldValue (JsonObject, character, handle, integer)

Purpose:	Adds the value of a buffer field to the JSON object used for
	the ETag value computation
Notes:	Uses a canonical (session format independent) representation
	per data type (SCL-5644)

Parameters:
poJson	Progress.Json.ObjectModel.JsonObject
	The JsonObject receiving the field value
pcName	CHARACTER
	The property name to add the value as
phField	HANDLE
	The handle of the buffer field
piIndex	INTEGER
	The extent index (0 for non-extent fields)

Top

CanFind (dataset-handle, CanFindParameter)

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

LOGICAL CanFind (character, character)

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

CountResultRecords (dataset-handle, ICountRecordsRequest)

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

INT64 CountResultRecords (ICountRecordsRequest)

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:
poParameter	Consultingwerk.OERA.ICountRecordsRequest
	The CharacterHolder to receive the list of TOP-NAV-BUFFERS
Returns	INT64
	The number of records returned by the query

Top

DestroyDataAccessObject ()

Purpose:	Unloads the DataAccess object
Notes:

Top

dispose ()

Purpose:	Destroy/Shutdown/Anti-Initializer
Notes:

Top

FetchChildTableRecords (handle)

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

FetchData (IFetchDataRequest)

Purpose:	Fetch data from the Data Access object
Notes:

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

Top

FetchData (IFetchDataRequest, handle)

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)
IMPORTANT:	If the calling code uses &SUFFIX on the dataset and/or
	temp-table includes, or otherwise changes the names of the
	temp-tables, then the DataAccess object MUST specify the
	canonical/defined buffer names in the DataAccess' (protected)
	DefinedBufferNames property. Failure to do so may result in
	queries failing For more information see the Consultingwerk.OERA.DataAccess
	class documentation.

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

FetchData (IFetchDataRequest, dataset-handle)

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

FetchDataByKeyTable (dataset-handle, IFetchDataByKeyTableParameter)

Purpose:	Supports 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 DATASET-HANDLE, only used for OUTPUT of the resulting dataset
poParameter	Consultingwerk.OERA.IFetchDataByKeyTableParameter
	The IFetchDataByKeyTableParameter with the data for this call

Top

FetchDataByKeyTable (IFetchDataByKeyTableParameter, handle)

Purpose:	Fetch data from the Data Access object
Notes:	This variant of FetchDataByKeyTable 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:
poParameter	Consultingwerk.OERA.IFetchDataByKeyTableParameter
	The IFetchDataByKeyTableParameter with the data for this call
phDataset	HANDLE
	The handle of the DATASET received BY-REFERENCE from the caller

Top

FetchDataByKeyValues (dataset-handle, FetchDataByKeysParameter)

Purpose:	Allows retrieve multiple DB records from a Business Entity based on
	extents of key values for one or more fields
Notes:	Proxy method to calling the same method in the data access class
	SCL-5229

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

Top

FetchDataByKeyValues (FetchDataByKeysParameter, handle)

Purpose:	Fetch data from the Data Access object
Notes:	This variant of FetchDataByKeyValues 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).
	SCL-5229

Parameters:
poParameter	Consultingwerk.OERA.FetchDataByKeysParameter
	The FetchDataByKeysParameter with the data for this call
phDataset	HANDLE
	The handle of the DATASET received BY-REFERENCE from the caller

Top

FetchDataByStaticQuery (dataset-handle, IFetchDataByStaticQueryRequest)

Purpose:	Retrieves data using a static query.
Notes:

Parameters:
phDataset	DATASET-HANDLE
	INPUT-OUTPUT DATASET-HANDLE, only used for OUTPUT of the resulting dataset
poParameter	Consultingwerk.OERA.IFetchDataByStaticQueryRequest
	The IFetchDataByStaticQueryRequest query for this call

Top

FetchDataByStaticQuery (IFetchDataByStaticQueryRequest, handle)

Purpose:	Retrieves data using a static query.
Notes:	This variant of FetchDataByStaticQuery 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:
poParameter	Consultingwerk.OERA.IFetchDataByStaticQueryRequest
	The IFetchDataByStaticQueryRequest with the data for this call
phDataset	HANDLE
	The handle of the DATASET received BY-REFERENCE from the caller

Top

FetchDataByTempTable (table-handle, IFetchDataByTempTableParameter, dataset-handle)

Purpose:	Supports retrieve multiple DB records from a Business Entity based on
	a join to an (external) temp-table
Notes:

Parameters:
phTable	TABLE-HANDLE
	The handle of the temp-table with which to perform a join while fetching data
poParameter	Consultingwerk.OERA.IFetchDataByTempTableParameter
	The IFetchDataByTempTableParameter with the data for this call
phDataset	DATASET-HANDLE
	INPUT-OUTPUT DATASET-HANDLE, only used for OUTPUT of the resulting dataset

Top

FetchDataset (dataset-handle)

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

FetchRelatedRecords (handle, character)

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

Consultingwerk.OERA.BusinessEntityDescriptor.IBusinessEntityDescriptor GetBusinessEntityDescriptor ()

Purpose:	Returns the Business Entity Descriptor for this Business Entity
Notes:	https://consultingwerk.atlassian.net/wiki/spaces/SCL/pages/8094518/Business+Entity+Descriptor

Returns	Consultingwerk.OERA.BusinessEntityDescriptor.IBusinessEntityDescriptor
	The IBusinessEntityDescriptor of the Business Entity

Top

GetBusinessEntityDescriptor (dataset-handle, GetBusinessEntityDescriptorParameter)

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	Consultingwerk.OERA.BusinessEntityDescriptor.GetBusinessEntityDescriptorParameter
	The GetBusinessEntityDescriptorParameter with the data for this call

Top

Ccs.BusinessLogic.IGetDataResponse getData (IGetDataRequest, dataset-handle)

Purpose:	Performs a read request
Notes:

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

Top

Consultingwerk.OERA.IDataAccess GetDataAccessObject ()

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

getDataset (dataset-handle)

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

Progress.Lang.Class GetDatasetModelType ()

Purpose:	Returns the class reference of the DatasetModel type
	associated with this Business Entity
Notes:

Returns	Progress.Lang.Class
	The Progress.Lang.Class reference

Top

CHARACTER GetETagValue (handle)

Purpose:	Returns the ETag value identifying the current version of the
	record in the given buffer
Notes:	Called by the RestEntitiesWebHandler for @RestAddress
	annotations with requireIfMatch="true" (SCL-5644) - both to
	return the ETag response header and to verify the If-Match
	request header on updates. The default implementation returns
	a SHA-256 hash over a canonical JSON serialization of all
	fields of the record, independent of session format settings.
	Override this method to base the ETag value on e.g. a version
	counter or last-changed timestamp field instead

Parameters:
phBuffer	HANDLE
	The buffer positioned on the record to return the ETag value for
Returns	CHARACTER
	The character ETag value

Top

GetInitialValues (dataset-handle, GetInitialValuesParameter)

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 ForeignKeyValues property 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

Consultingwerk.OERA.RestResource.ListRestAddress GetRestAddresses ()

Purpose:	Returns the list of supported rest addresses to the caller
Notes:

Returns	Consultingwerk.OERA.RestResource.ListRestAddress
	The list of supported rest addresses to the caller

Top

Consultingwerk.OERA.RestResource.ListRestMethod GetRestMethods ()

Purpose:	Returns the list of supported rest addresses for methods
	to the caller
Notes:

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

Top

Ccs.BusinessLogic.IGetResultCountResponse getResultCount (IGetDataRequest)

Purpose:	Returns the count of the total number of result records or a guess
	of the result count to the caller
Notes:

Parameters:
poRequest	Ccs.BusinessLogic.IGetDataRequest
	The IGetDataRequest instance with the getResultCount request parameters
Returns	Ccs.BusinessLogic.IGetResultCountResponse
	The IGetResultCountResponse instance

Top

Consultingwerk.OERA.IFetchDataByStaticQueryRequest GetStaticQueryRequest (character, character, character, character)

Purpose:	Returns a strong-typed static query request instance for the
	given table and field combination
Notes:	SCL-5708. The default implementation returns the unknown value,
	indicating that no static query is available - callers (e.g.
	the RestEntitiesWebHandler) fall back to a dynamic query then.
	The Business Entity Designer StaticDataAccessQueryPlugin
	generates an override of this method into the Business Entity,
	mapping the field combinations of unique indexes to the
	matching generated IFetchDataByStaticQueryRequest class

Parameters:
pcTableName	CHARACTER
	The name of the (temp-)table the request is for
pcFieldNames	CHARACTER
	Comma-separated list of temp-table field names
pcFieldValues	CHARACTER
	CHR(1)-separated list of field values, positionally matching pcFieldNames
pcChildTables	CHARACTER
	Comma-separated list of child table names to be filled
Returns	Consultingwerk.OERA.IFetchDataByStaticQueryRequest
	The IFetchDataByStaticQueryRequest instance or the unknown value

Top

Progress.Lang.Class GetTableModelType (character)

Purpose:	Returns the class reference of the TableModel type
	associated with this Business Entity
Notes:

Parameters:
pcTableName	CHARACTER
	The name of the temp-table
Returns	Progress.Lang.Class
	The Progress.Lang.Class reference

Top

CHARACTER GetTopNavBuffers ()

Purpose:	Returns the names of the dataset TOP-NAV-BUFFER's
Notes:

Returns	CHARACTER
	The list of TOP-NAV-BUFFERS

Top

GetTopNavBuffers (dataset-handle, CharacterHolder)

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

initialize ()

Purpose:	Initializer/Startup
Notes:

Top

InitializeDataAccessObject ()

Purpose:	Initializes the DataAccess Object
Notes:	Uses the DataAccessName property

Top

InvokeReceiveData (RequestTypeEnum, Object)

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	Consultingwerk.OERA.Enum.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

LOGICAL PopulateFromPartialBuffer (handle)

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

PopulatePartialBuffer (handle)

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

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 ()
	Abstract method to be implemented by the actual Business Entity

Top

Consultingwerk.OERA.FetchDataRequest RequestForKeyField (character, character, character)

Purpose:	Factory method for the FetchDataRequest class
Notes:	Return a request instance based on a table, key field and value

Parameters:
pcTableName	CHARACTER
	The name of the temp-table to request
pcKeyFieldName	CHARACTER
	The name of the key field
pcKeyFieldValue	CHARACTER
	The value of the key field
Returns	Consultingwerk.OERA.FetchDataRequest
	The FetchDataRequest instance

Top

Consultingwerk.OERA.FetchDataRequest RequestForKeyField (character, character, decimal)

Purpose:	Factory method for the FetchDataRequest class
Notes:	Return a request instance based on a table, key field and value

Parameters:
pcTableName	CHARACTER
	The name of the temp-table to request
pcKeyFieldName	CHARACTER
	The name of the key field
pdeKeyFieldValue	DECIMAL
	The value of the key field
Returns	Consultingwerk.OERA.FetchDataRequest
	The FetchDataRequest instance

Top

Consultingwerk.OERA.FetchDataRequest RequestForKeyField (character, character, integer)

Purpose:	Factory method for the FetchDataRequest class
Notes:	Return a request instance based on a table, key field and value

Parameters:
pcTableName	CHARACTER
	The name of the temp-table to request
pcKeyFieldName	CHARACTER
	The name of the key field
piKeyFieldValue	INTEGER
	The value of the key field
Returns	Consultingwerk.OERA.FetchDataRequest
	The FetchDataRequest instance

Top

ResetState ()

Purpose:	Resets the state of the Business Entity by emptying temp-tables
Notes:	If the dataset or any temp-tables have been passed BY-REFERENCE and
	a reference. This method is typically called from an AppServer's
	deactivate procedure via the ServiceInterface's RequestEnded event

Top

ResetState (handle, Object, character)

Purpose:	Resets the state of the Business Entity by emptying temp-tables
Notes:	If the dataset or any temp-tables have been passed BY-REFERENCE and
	a reference. This method is typically called from an AppServer's
	deactivate procedure via the ServiceInterface's RequestEnded event

Parameters:
phDataset	HANDLE
	The handle of the ProDataset
poThisObject	Progress.Lang.Object
	The reference to the service instance calling into this method
pcServiceType	CHARACTER
	The type of Business Service for logging purposes

Top

RestoreDatasetHandle ()

Purpose:	Restores the DatasetHandle property value
Notes:

Top

SaveChanges ()

Purpose:	Saves changes using the DataAccess object
Notes:	This method saves changes contained in the dataset currently present
	in the Business Entity

Top

SaveChanges (dataset-handle)

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

SaveChanges (dataset-handle, Object)

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

SaveChanges (IActionType)

Purpose:	Saves changes with an Action Type instance
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
	Validation is completely delegated to the Action Type instance

Parameters:
poActionType	Consultingwerk.OERA.IActionType
	The Action Type instance

Top

SavePartialChanges (dataset-handle, Object)

Purpose:	Saves partial changes to the Business 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 separate 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

CHARACTER SourceColumn (character, character)

Purpose:	Returns the database field name matching a temp-table field name
Notes:

Parameters:
pcTempTableName	CHARACTER
	The temp-table buffer name to return the source column for
pcColumn	CHARACTER
	The temp-table field name
Returns	CHARACTER
	The database field name

Top

Consultingwerk.CharacterHolder SourceColumn (SourceColumnRequest)

Purpose:	Returns the database field name matching a temp-table field name
Notes:

Parameters:
poRequest	Consultingwerk.OERA.SourceColumnRequest
	The SourceColumnRequest instance
Returns	Consultingwerk.CharacterHolder
	The CharacterHolder with the database field name

Top

CHARACTER UniqueFindPredicateWithValueBuffer (handle, handle, character)

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

Progress.Lang.Object updateData (dataset-handle, IUpdateDataRequest)

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	Ccs.BusinessLogic.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

ValidateAddOnlyColumns (handle, character)

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

ValidateBasedOnBusinessEntityDescriptor ()

Purpose:	Performs validation based on the Business Entity Descriptor
	properties
Notes:

Top

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
	Abstract method to be implemented by the actual Business Entity

Top

ValidateData (dataset-handle, IValidateDataContext)

Purpose:	Provides a client callable method for data validation
Notes:	Invokes ValidateData(), but not linked to any SaveChanges invocation
	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

ValidateMandatoryColumns (handle, character)

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

ValidatePartialData (dataset-handle, IValidateDataContext)

Purpose:	Provides a client callable method for partial data validation
Notes:	Invokes ValidateData(), but not linked to any SaveChanges invocation
	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

ValidateReadOnlyColumns (handle, character)

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

STATIC BusinessEntity ()

Purpose:	Static Constructor for the BusinessEntity class
Notes:

Top

BusinessEntity (handle)

Purpose:	Constructor for the BusinessEntity class
Notes:

Parameters:
phDataset	HANDLE
	The handle of the Business Entity Dataset (passed from the actual Business Entity)

Property Detail

Top

Progress.Lang.Enum ActionType

Returns	Progress.Lang.Enum

Top

CHARACTER ContextID

Returns	CHARACTER

Top

CHARACTER DataAccessName

Returns	CHARACTER

Top

Consultingwerk.OERA.IDataAccess DataAccessObject

Returns	Consultingwerk.OERA.IDataAccess

Top

HANDLE DatasetHandle

Returns	HANDLE

Top

Consultingwerk.OERA.IFetchDataRequest FetchDataRequest

Returns	Consultingwerk.OERA.IFetchDataRequest

Top

HANDLE OriginalDatasetHandle

Returns	HANDLE

Top

Consultingwerk.OERA.Enum.RequestTypeEnum RequestType

Returns	Consultingwerk.OERA.Enum.RequestTypeEnum

Top

Progress.Lang.Object SaveChangesParameter

Returns	Progress.Lang.Object

Top

LOGICAL TrackingChanges

Returns	LOGICAL

Top

Consultingwerk.OERA.IValidateDataContext ValidateDataContext

Returns	Consultingwerk.OERA.IValidateDataContext

info@consultingwerk.de http://www.consultingwerk.de 19.09.2026 10:08:01