Parentpacke: Consultingwerk
Consultingwerk.OERA

The Consultingwerk.OERA package contains core data access functionality that follows the principles of the OpenEdge Reference Architecture. The following table lists the main classes of this package:

Class name Description
BusinessEntity The base class for Business Entities. Business Entities manage a ProDataset and provide methods to read and update data from and to the database as well as additional (custom) operations related to the data.
DataAccess The DataAccess class is the base class for Data Access Objects. Data Access objects are used by Business Entities to actually read from and write to the database.
ServiceAdapter The ServiceAdapter provides access to the backend services from the client. The ServiceAdapter is referenced on the client using Consultingwerk.Framework.FrameworkSettings:ServiceAdapter reference.
ServiceInterface The ServiceInterface provides access to the backend services from the backend.

Subpackages
Consultingwerk.OERA.BusinessEntityDescriptor
Consultingwerk.OERA.Ccs
Consultingwerk.OERA.Context
Consultingwerk.OERA.Enum
Consultingwerk.OERA.Exceptions
Consultingwerk.OERA.JsdoGenericService
Consultingwerk.OERA.LegacyAdapter
Consultingwerk.OERA.ModelFilter
Consultingwerk.OERA.Monitoring
Consultingwerk.OERA.OpenAccess
Consultingwerk.OERA.Query
Consultingwerk.OERA.QueryBuilder
Consultingwerk.OERA.Resources
Consultingwerk.OERA.RestAdapter
Consultingwerk.OERA.RestResource
Consultingwerk.OERA.Swagger
Consultingwerk.OERA.TableStatistics
Consultingwerk.OERA.ValidationMessages

Interfaces
IBufferDataSource Interface for classes encapsulating a dynamic data-source handle
IBufferSpec Describes a dynamic buffer
IBusinessEntity Provides Access and Business Logik for a ProDataset
IBusinessService Non functional Interface for Business Services (functional requirements; no methods required to implement IBusinessService)
IBusinessTaskCatalogData Describes the REST/JSDO Interface to a Business Task
IBusinessTaskCatalogInfo Interface for Business Tasks that should support REST/JSDO catalog generation through the generic service
IBusinessTaskMethodData Describes a Business Task Method for REST/JSDO Catalog generation
IContextWrapper ContextWrapper Interface
ICountRecordsRequest Interface for classes extending IFetchDataRequest with the ability to count result records of a query
ICountResultsCache Interface for services that store a cache of record counts
IDataAccess Interface definition for OERA Data Access objects
IDataAccessCanFind Interface for DataAccess implemementation that support the CanFind method
IDataAccessCountRecords Interface for Data Access classes that do support the CountResultRecords method
IDataAccessFactory Factory of IDataAccess classes
IDatasetModelUseInterfaceProvider Interface for Services determing the UseInterface property of new DatasetModel instances
IDataSourceInfo Interface for general purpose Datasource (Business Entity) view parameter
IDataSourceQueryInfo Interface for Holder Classes that may receive information about the data source queries executed by the DataAccess
IDataSourceQueryInfoProvider Interface for classes that provide data source query information (for tracing purposes)
IDSQueryString Interface for Data-Source Query Manipulation routine
IFetchDataByKeyTableParameter Parameter object for the FetchDataByKey method of the BusinessEntity and DataAccess class
IFetchDataByKeyTableRequest Extended Parameter object for the FetchDataByKey method of the BusinessEntity and DataAccess class
IFetchDataByReference Interface indicating that the implementing Business Entity supports the BY-REFERENCE calling of the FetchData method
IFetchDataBySkip Interface for IFetchDataRequest implementations that do provide the "Skip" parameter as required for the server side batching/paging with JSDO/Kendo UI
IFetchDataRequest Parameter object for FetchData requests
IHasContextID Interface for Business Services (e.g. Business Entities) that support multiple instances in the ServiceManager (ServiceInterface) distinguished by a ContextID
INamedQueryParameter Interface for parameters provided as named queries
IProcessFetchDataRequestVariablesQueryWalker Interface for services implementing the IQueryExpressionWalker used by the method DataAccess:ProcessFetchDataRequestVariables
IProvidesSmartRecordInformation Interface for Data Access classes that provide the SmartRecordKey
IServiceAdapter Interface allowing customized implementations of the OERA ServiceAdapter (client side)
IServiceAdapterWithContextDataset Interface to be implemented by ServiceAdapter implementations that support a custom context dataset
IServiceAdapterWithContextEvents Declares events that may be used to collect the Context for the AppServer
IServiceAdapterWithInvokeTask Interface to be implemented by ServiceAdapter implementations that support the InvokeTask methods
IServiceAdapterWithInvokeTaskAsync Interface to be implemented by ServiceAdapter implementations that support the InvokeTask methods
IServiceAdapterWithSubmitDataParameter Interface to be implemented by ServiceAdapter implementations that support the SubmitData calls with on additional parameter object instance
IServiceManager Service Interface for classes that manages Business Entity or Business Task instances (IBusinessService interface) for the Service Interface
IServiceManagerClient Service Interface for classes that can shut down business tasks on the server (client for the ServiceManager)
IServiceManagerLifeCycleProvider Interface for services that provide service life cycle definition to the ServiceManagerImpl class
IServiceNameMappingService Interface for services that support the mapping of the business service name (e.g. Business Entity or Business Task) to the actual class name
ISmartUiAction Interface for the payload of the SmartUiAction field
ISmartUiActionQuestionWalkerCallback Interface for classes with a callback method for the SmartUiActionQuestionWalker
ITableModelQuestionProvider Interface for services deserializing or serializing the ListQuestions associated with a buffer
IValidateDataContext Interface for parameter objects for the invokable version of the ValidateData method in the Business Entity

Classes
AsyncTaskCompletedEventArgs Event argument for the AsyncTaskCompleted event of the ServiceAdapter
BufferDataSource Encapsulates a dynamic data-source handle
BufferDataSourceBuilder Static Builder for IBufferDataSource instances
BufferSpec Describes a dynamic buffer
BusinessEntity Provides Access and Business Logik for a ProDataset
BusinessEntityResultsetMapper Allows mapping a Business Entity Resultset (ProDataset) into a Temp-Table
BusinessTask (Optional) Abstract base class for Business Tasks
BusinessTaskCatalogData Describes the REST/JSDO Interface to a Business Task
BusinessTaskMethodData Describes a Business Task Method for REST/JSDO Catalog generation
CanFindParameter Parameter object to the BusinessEntity:CanFind method
ContextWrapper Provides access to the context dataset
ContextWrapperImpl ContextWrapper Implementation
CountRecordsRequest Parameter object for count record requests
CountResultsCache Services that stores a cache of record counts
DataAccess Abstract base class for OERA Data Access objects
DataAccessFactory Default Factory of IDataAccess classes
DataMaintenanceBusinessTask Base class for business tasks implementing the IBusinessEntity interface to support data retrieval and update through the JSDO generic service
DatasetModel Model base class for a Dataset
DatasetModelPerformer Performs the backend requests of the Dataset Model class
DatasetModelUseInterfaceProvider Default service determing the UseInterface property of new DatasetModel instances
DataSourceInfo General purpose Datasource (Business Entity) view parameter
DataSourceQueryInfo Holder class for data source query information
DataSourceQueryInfoProvider Provides data source query information (for tracing purposes) to the DataAccess:FetchData method
EntityTable
FetchDataAccessRequest Extension to FetchDataRequest with specific instructions for the Data Access class. It is only expected to be used from within a Business Entity
FetchDataException Exception thrown from the DataAccess:FetchData method
FetchDataRequest Parameter object for FetchData requests
FieldValidationError Performs formatting of field validation errors
FilterParameter JSON serializable class that can be used to deserialize the complex filter parameter used by Rollbase, DataDirect OpenAccess SDK for OpenEdge etc.
FindRecordResult Result class for the Consultingwerk.OERA.DataAccess FindRecord method
GenericFetchDataByKeyTableParameter General purpose parameter class for the FetchDataByKeyTable method of the BusinessEntity and DataAccess class
GetInitialValuesParameter Parameter object for the GetInitialValues method of the BusinessEntity class
HandleCommitErrorEventArgs Event Argument for the HandleCommitError event and HandleCommitSysError of the Data Access class
ListBufferSpec Generic List of BufferSpec objects
ListBusinessTaskMethodData List of IBusinessTaskMethodData instances
ListTableModel Generic List for the TableModel class
NamedQueryParameter Parameter class for named queries
NamedQueryParameterEntry Entry of the NamedQueryParameter list
NamedQueryParameterList List of parameters to named queries
ProcessFetchDataRequestVariablesQueryWalker Query Expression Walker used by the method DataAccess:ProcessFetchDataRequestVariables
ResultsetQueryBuilder Creates and prepares the query used to join (in case multiple the tables have been chosen) the resultset before returning it to the caller
ResultsetTempTableFactory Creates the temp-table that is returned to the caller when multiple ProDataset tables will be joined into a single resultset
SaveRowChangesEventArgs
ServiceAdapter Default OERA ServiceAdapter implementation
ServiceInterface The OERA ServiceInterface which is the suggested method of accessing business logic
ServiceInterfaceLogger Logs requests to the ServiceInface
ServiceManager Manages running Service (Business Services) instances Typically Business Entities and Business Tasks
ServiceManagerClient Default IServiceManagerClient implementation
ServiceManagerClientTask Business Task used by the Consultingwerk.OERA.ServiceManagerClient
ServiceManagerImpl Default IServiceManager implementation that manages Business Entity or Business Task instances (IBusinessService interface) for the Service Interface
ServiceManagerLifeCycleProvider Services that provide service life cycle definition to the ServiceManagerImpl class
ServiceNameMappingService Default implementation of IServiceNameMappingService Interface. Supports the mapping of the business service name (e.g. Business Entity or Business Task) to the actual class name
SmartUiAction Payload for the SmartUiAction field
SmartUiActionQuestionWalker Iterates the buffers of a ProDataset and calls back into the callback routing
TableModel Abstract base class for Temp-Table Models
TableModelEnumerator Enumerator for TableModel instances
TableModelQuestionProvider Implementation of the ITableModelQuestionProvider service based on the Consultingwerk SmartUiAction implementation
Validate Provides Assertion-Style validation routines for ProDataset buffers
ValidateDataContext Parameter object for the invokable version of the ValidateData method in the Business Entity
ValidationDefaultMessages Static class containing the default validation message used by the Consultingwerk.OERA.Validate class
ValidationHelper Provides Assertion-Style validation routines for ProDataset buffers

Enums
BusinessServiceTypeEnum Enum for types of Business Service to be queried from ServiceManager:IsRunning
DatasetModelModeEnum
DatasetParameterModeEnum Describes the part mode (INPUT, OUTPUT, INPUT-OUTPUT) of a Dataset Parameter
NotRunningServiceEnum Enum as a parameter to Consultingwerk.OERA.ServiceManager:StopBusinessService
OnNotAvailableEnum
OptionsOnDisconnectEnum Enum for the Options used by the Service Adapter when the AppServer Connection is not available (ServiceAdapter:BehaviorOnDisconnect)
QueryJoinEnum Enum with possible values for the QueryJoin property of the IBufferSpec interface, see BufferDataSource
QueryPurposeEnum Enumeration for the values of the DataAccess:QueryPurpose property; enumaration of the possible usage purposes of the SourceDefaultQuery callback
QueryTypeEnum
SpecialParameterEnum
TableModelTypeEnum Enum describing the kind of a table model: TableModel, ViewModel or BufferModel
UseInterfaceEnum Enum describing the type of Interface to use for a Business Entity Request: ServiceAdapter or ServiceInterface

©2006-2019 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       09.08.2019 00:10:27