SmartComponent Library

Parentpacke:

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.BusinessEntityDispatcher
	Consultingwerk.OERA.Ccs
	Consultingwerk.OERA.Context
	Consultingwerk.OERA.DatasetModel
	Consultingwerk.OERA.DynamicBusinessEntity
	Consultingwerk.OERA.Enum
	Consultingwerk.OERA.Exceptions
	Consultingwerk.OERA.Integrations
	Consultingwerk.OERA.JsdoGenericService
	Consultingwerk.OERA.LegacyAdapter
	Consultingwerk.OERA.ModelFilter
	Consultingwerk.OERA.Monitoring
	Consultingwerk.OERA.OpenAccess
	Consultingwerk.OERA.Query
	Consultingwerk.OERA.QueryBuilder
	Consultingwerk.OERA.RequestManager
	Consultingwerk.OERA.Resources
	Consultingwerk.OERA.RestAdapter
	Consultingwerk.OERA.RestResource
	Consultingwerk.OERA.Swagger
	Consultingwerk.OERA.TableStatistics
	Consultingwerk.OERA.TempTableStatistics
	Consultingwerk.OERA.ValidationMessages

Interfaces
	IActionType	Interface for ActionType implementations
	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
	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
	IDataAccessReceiveData	Interface for Data Access classes that provide the optional ReceiveData method to update the ProDataset in the Data Access layer similar to the ReceiveData method in the Business Entity Layer
	IDatasetModel
	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
	IFetchDataAccessRequest	Extension to IFetchDataRequest with specific instructions for the Data Access class. It is only expected to be used from within a Business Entity
	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
	IFetchDataByStaticQueryRequest	Interface describing parameter values for a static query request
	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
	IProvidesActionType
	IProvidesSmartRecordInformation	Interface for Data Access classes that provide the SmartRecordKey
	IQueryExpressionFilter	Supports filtering the client query expression in the Data Access
	IQueryStringFilter	Supports filtering the client query string in the Data Access
	IServiceAdapter
	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
	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
	ISupportsQueryExpressionWithSort	Marker interface used by DatasetModels to build an appropriate FetchDataRequest object
	ISupportsQuickSearch	Marker Interface for Business Entities supporting the QuickSearch named query (q - query string parameter for RESTful entnties)
	ISupportsResetState	Indicates that an object can reset its state (typically a business service)
	ITableModel
	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
	IValidationDelegate

Classes
	ActionType	Base class for Action Types
	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 Logic for a ProDataset
	BusinessEntityBusinessTask	Base class for Business Tasks used as a facade to one or multiple business entities
	BusinessEntityResultsetMapper	Allows mapping a Business Entity Resultset (ProDataset) into a Temp-Table
	BusinessTask
	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
	ContextWrapperImpl
	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
	DatasetBufferFieldErrorString	More OO-like method to set the ProDataset Buffer's ERROR-STRING and ERROR attributes compared to the DatasetHelper:AddErrorString, used from the DatasetErrorString class
	DatasetErrorString	More OO-like method to set the ProDataset Buffer's ERROR-STRING and ERROR attributes compared to the DatasetHelper:AddErrorString
	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
	DataSourceKeys	Value Object for the DataSource Keys phrase of the BufferSpec
	DataSourceQueryInfo	Holder class for data source query information
	DataSourceQueryInfoProvider	Provides data source query information (for tracing purposes) to the DataAccess:FetchData method
	DynamicInvokeBusinessTask	Supports dynamic invokation on an ABL class method on the backend
	DynamicInvokeParameter
	EntityTable
	EscapeCurlyBracesQueryFilter	QueryString filter which escapes curly braces in the query string
	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
	FetchOptions	Optional parameter object for dataset constructors
	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
	GenericFetchDataByKeyTableRequest
	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
	OERAServices	Static Names for the Consultingwerk.OERA Package
	ProcessFetchDataRequestVariablesQueryWalker	Query Expression Walker used by the method DataAccess:ProcessFetchDataRequestVariables
	QuickSearchParameter	Strong typed named query implementation for QuckSearch
	ResultsetQueryBuilder	Creates and prepares the query used to join (in case multiple the tables have been chosen) the result set 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
	RetrieveDataAsyncCompletedEventArgs	Event argument for the RetrieveDataAsyncCompleted event of the ServiceAdapter
	SaveRowChangesEventArgs
	ServiceAdapter
	ServiceInterface	The OERA ServiceInterface which is the suggested method of accessing business logic
	ServiceInterfaceLogger	Logs requests to the ServiceInface
	ServiceManager
	ServiceManagerClient	Default IServiceManagerClient implementation
	ServiceManagerClientTask	Business Task used by the Consultingwerk.OERA.ServiceManagerClient
	ServiceManagerImpl
	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
	SourceColumnRequest
	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
	BufferModelGcModeEnum	Enum describing if a BufferModel should delete it's Buffer or Temp-Table when it's deleted
	BusinessServiceOperatingModeEnum	Enum with options for the ServiceManager:GetBusinessService operating mode Managed: The ServiceManager remains control over the life cycle of the service Unmanager: The caller is responsible for the life cycle of the service
	BusinessServiceTypeEnum	Enum for types of Business Service to be queried from ServiceManager:IsRunning
	DatasetModelModeEnum	Enum controlling if the ModelClassGeneratorPlugin will generate classes, interfaces or read-only interfaces
	DatasetParameterModeEnum	Describes the part mode (INPUT, OUTPUT, INPUT-OUTPUT) of a Dataset Parameter
	GenericFetchDataByKeyTableParameterCloneMode	Argument to the Clone() method of the GenericFetchDataByKeyTableParameter class
	NotRunningServiceEnum	Enum as a parameter to Consultingwerk.OERA.ServiceManager:StopBusinessService
	OnNotAvailableEnum	Enum controlling the DatasetModel/TableModel behavior when a record is not found using the provided query
	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	Enumeration of the type of a query (EACH, FIRST, LAST)
	SerializationTypeEnum	Enum for serialization type (eg ABL) for Service Manager
	SpecialParameterEnum	Enum to indicate special parameter types
	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