Namespace: Ccs.BusinessLogic
Interface 
IUpdatableBusinessEntity Copy to Clipboard
Parent classes:
Inherits: Ccs.BusinessLogic.IBusinessEntity
Implemented by: Consultingwerk.BusinessEntityDesigner.Services.BusinessEntityBusinessEntity, Consultingwerk.BusinessEntityDesigner.Services.DatabaseSchemaBusinessEntity, Consultingwerk.OERA.BusinessEntity, Consultingwerk.OERA.BusinessEntityDispatcher.BusinessEntityDispatcher, Consultingwerk.OERA.DynamicBusinessEntity.DynamicBusinessEntity, Consultingwerk.OERA.DynamicBusinessEntity.RestAddressDummyDynamicBusinessEntity, Consultingwerk.RollbaseAdapter.MetaData.ObjectDefBusinessEntity, Consultingwerk.RollbaseAdapter.MetaData.ObjectDefNamesBusinessEntity, Consultingwerk.SmartFramework.Authentication.UserBusinessEntity, Consultingwerk.SmartFramework.Authentication.UserProfileBusinessEntity, Consultingwerk.SmartFramework.Authorization.FieldSecurityItemBusinessEntity, Consultingwerk.SmartFramework.Authorization.GroupBusinessEntity, Consultingwerk.SmartFramework.Authorization.MenuGroupBusinessEntity, Consultingwerk.SmartFramework.Authorization.ParentGroupBusinessEntity, Consultingwerk.SmartFramework.Authorization.SecurityAssignmentBusinessEntity, Consultingwerk.SmartFramework.Authorization.SecurityObjectBusinessEntity, Consultingwerk.SmartFramework.Authorization.SecurityRealmBusinessEntity, Consultingwerk.SmartFramework.Authorization.SecurityTokenBusinessEntity, Consultingwerk.SmartFramework.Authorization.ToolbarSecurityItemBusinessEntity, Consultingwerk.SmartFramework.Authorization.UserGroupBusinessEntity, Consultingwerk.SmartFramework.Context.ContextStoreBusinessEntity, Consultingwerk.SmartFramework.Lock.LockBusinessEntity, Consultingwerk.SmartFramework.Menu.MenuBusinessEntity, Consultingwerk.SmartFramework.Menu.MenuStyleBusinessEntity, Consultingwerk.SmartFramework.Menu.ModuleBusinessEntity, Consultingwerk.SmartFramework.Menu.ProductBusinessEntity, Consultingwerk.SmartFramework.Repository.BusinessEntities.MetaBusinessEntity.MetaBusinessEntityBusinessEntity, Consultingwerk.SmartFramework.Repository.BusinessEntities.MetaDataSource.MetaDataSourceBusinessEntity, Consultingwerk.SmartFramework.Repository.BusinessEntities.MetaEntityTable.MetaEntityTableBusinessEntity, Consultingwerk.SmartFramework.Repository.BusinessEntities.RepositoryObjectBusinessEntity, Consultingwerk.SmartFramework.Repository.Class.AttributeBusinessEntity, Consultingwerk.SmartFramework.Repository.Class.AttributeGroupBusinessEntity, Consultingwerk.SmartFramework.Repository.Class.AttributeUsed.AttributeValueBusinessEntity, Consultingwerk.SmartFramework.Repository.Class.AttributeValueBusinessEntity, Consultingwerk.SmartFramework.Repository.Class.ClassTypeBusinessEntity, Consultingwerk.SmartFramework.Repository.Class.LinkTypeBusinessEntity, Consultingwerk.SmartFramework.Repository.Class.ObjectTypeBusinessEntity, Consultingwerk.SmartFramework.Repository.Class.SupportedInstanceObjectTypeBusinessEntity, Consultingwerk.SmartFramework.Repository.Class.SupportedLinkBusinessEntity, Consultingwerk.SmartFramework.Repository.Customization.CustomizationBusinessEntity, Consultingwerk.SmartFramework.Repository.Customization.CustomizationTypeBusinessEntity, Consultingwerk.SmartFramework.Repository.Field.EntityFieldMappingBusinessEntity, Consultingwerk.SmartFramework.Repository.Object.Export.ObjectMasterBusinessEntity, Consultingwerk.SmartFramework.Repository.Object.ObjectMasterBusinessEntity, Consultingwerk.SmartFramework.Repository.Object.WhereUsed.WhereUsedBusinessEntity, Consultingwerk.SmartFramework.Repository.ScreenMapping.EntityTableMappingBusinessEntity, Consultingwerk.SmartFramework.Repository.ScreenMapping.ScreenTypeBusinessEntity, Consultingwerk.SmartFramework.Repository.ScreenMapping.UiTypeBusinessEntity, Consultingwerk.SmartFramework.Scheduler.SchedulerJobBusinessEntity, Consultingwerk.SmartFramework.Scheduler.SchedulerJobPlanBusinessEntity, Consultingwerk.SmartFramework.Scheduler.SchedulerJobStatusBusinessEntity, Consultingwerk.SmartFramework.SmartBusinessEntity, Consultingwerk.SmartFramework.System.AttachmentBusinessEntity, Consultingwerk.SmartFramework.System.AttachmentRoleBusinessEntity, Consultingwerk.SmartFramework.System.CommentRoleBusinessEntity, Consultingwerk.SmartFramework.System.ConfigurationValueBusinessEntity, Consultingwerk.SmartFramework.System.DeletionBusinessEntity, Consultingwerk.SmartFramework.System.KeyFieldAssignmentTypeBusinessEntity, Consultingwerk.SmartFramework.System.LanguageBusinessEntity, Consultingwerk.SmartFramework.System.LoginCompanyBusinessEntity, Consultingwerk.SmartFramework.System.MessageBusinessEntity, Consultingwerk.SmartFramework.System.ModifiedStateBusinessEntity, Consultingwerk.SmartFramework.System.RelationBusinessEntity, Consultingwerk.SmartFramework.System.SmartBusinessEntityBusinessEntity, Consultingwerk.SmartFramework.System.TableBusinessEntity, Consultingwerk.SmartFramework.System.TranslationBusinessEntity, Consultingwerk.SmartFramework.System.UiTranslationBusinessEntity, Consultingwerk.SmartFramework.System.ValueListBusinessEntity, Consultingwerk.SmartFramework.Web.RouteBusinessEntity, Consultingwerk.SmartFramework.Workflow.WorkflowBusinessEntity, Consultingwerk.SmartFramework.Workflow.WorkflowInstanceBusinessEntity, Consultingwerk.Util.ClassHelper.ClassHelperBusinessEntity, Consultingwerk.Windows.Framework.Localization.UserInterfaceCultureBusinessEntity

This Software is licensed by Progress Software Corporation (licensor)
under the Progress Software Common Component Specification Project
Release License Agreement available at
https://community.progress.com/products/directions/common_component/p/releaselicenseagreement
The Interface definition is part of the Common Component Specification [CCSBE01]. The
file is considered as a Specification Implementation Condition as described
in section 2.1.1.1: If Licensor has made Specification Implementation
Conditions available as of the date Licensee completes its Independent
Implementation, then Licensee must, prior to making any claim that its
Independent Implementation complies with the Specification, ensure that
the Independent Implementation satisfies all of the Specification
Implementation Conditions. If Licensor subsequently makes available or
updates, from time to time, the Specification Implementation Conditions,
then Licensee will verify that its Independent Implementation satisfies the
latest version of the Specification Implementation Conditions within ninety
(90) days following Licensor's release thereof.
Contributors:
Mike Fechner, Consultingwerk [2016]
File:IUpdatableBusinessEntity
Purpose:CCSBE 1.0 Interface for Business Entities with support to
update data
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sun May 22 18:49:41 CEST 2016
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



Top Method Summary
Options Name Purpose
+ dispose () /* Destroy/Shutdown/Anti-Initializer */
Inherited from Ccs.Common.IService
+ Ccs.BusinessLogic.IGetDataResponse getData (IGetDataRequest, dataset-handle) Performs a read request
Inherited from Ccs.BusinessLogic.IBusinessEntity
+ getDataset (dataset-handle) Returns an empty instance of the primary ProDataset to the caller
Inherited from Ccs.BusinessLogic.IBusinessEntity
+ 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
Inherited from Ccs.BusinessLogic.IBusinessEntity
+ initialize () /* Initializer/Startup */
Inherited from Ccs.Common.IService
+ Progress.Lang.Object updateData (dataset-handle, IUpdateDataRequest) Stores data modifications in the persistent storage (typically a database)


Method Detail
Top

PUBLIC dispose ()

Inherited from Ccs.Common.IService
/* Destroy/Shutdown/Anti-Initializer

Top

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

Inherited from Ccs.BusinessLogic.IBusinessEntity
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

PUBLIC getDataset (dataset-handle)

Inherited from Ccs.BusinessLogic.IBusinessEntity
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 Ccs.BusinessLogic.IGetResultCountResponse getResultCount (IGetDataRequest)

Inherited from Ccs.BusinessLogic.IBusinessEntity
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

PUBLIC initialize ()

Inherited from Ccs.Common.IService
/* Initializer/Startup

Top

PUBLIC 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


©2006-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       29.06.2022 12:37:25