Consultingwerk.SmartComponents.Implementation.SmartBusinessEntityAdapter

Namespace:

Consultingwerk.SmartComponents.Implementation

Class

SmartBusinessEntityAdapter

Parent classes:

Consultingwerk.SmartComponents.ComponentBase

Consultingwerk.SmartComponents.Base.SmartComponent

Consultingwerk.SmartComponents.Base.SmartDataAdapter

Consultingwerk.SmartComponents.Base.SmartDatasetAdapter

Consultingwerk.SmartComponents.Implementation.SmartBusinessEntityAdapter

Inherits:

Consultingwerk.SmartComponents.Base.SmartDatasetAdapter

Implements:

Inherited by:

Consultingwerk.SmartComponents.Tools.OERABusinessEntityTester.SmartBusinessEntityAdapterTester

Top Method Summary

	Options	Name	Purpose
		AttachQueryToBindingSource ()	Attaches the Query/ProDataset to the BindingSource
		BeginTransactionState ()	Begins a transaction when starting update
		ClearQuestions (handle)	Clears the questions
		CloseQuery ()	Empty the DATASET inside the DataAdapter and reopen Query.
		LOGICAL CommitTransaction ()	Commits the transaction to the backend
		CopyErrorsIntoDataset (handle)	Copies the errors from the changes dataset into the dataset of he SmartBusinessEntityAdapter instance
		EmptyDataset ()	Empties the ProDataset
		EndInit ()	Executed at the end of the initialization of the SmartBusinessEntityAdapter to launch the DatasetController (if any).
		EndUpdateState (ISmartDataTarget)	The Message to for instance enable a Browser is send to all SmartDataTargets except the calling one.
		EndUpdateStateInDataSource (ISmartDataTarget)	Invokes EndUpdateState in the SmartDataSource of this SmartDataAdapter
		CHARACTER EvaluateParentQueryAfterUpdate ()	Evaluates the QueryString based on the Parent Filter Fields after UpdateRow
		LOGICAL FetchAll ()	Fetches all remaining data from the backend
		LOGICAL FetchFirst ()	Overrides FetchFirst in SmartDataAdapter. Retrieves the first batch of records when backwards batching
		LOGICAL FetchLast ()	Overrides FetchLast in SmartDataAdapter to retrieve full business entity result when batching.
		FetchLastOnServer ()	Fetch Last On Server, used by FetchLast when FetchLastOnServer = TRUE
		FetchMoreRowsForwards (integer)	Fetches additional rows forwards
		LOGICAL FetchPrev ()	Overrides FetchPrev in SmartDataAdapter. Retrieves the previous batch of records when backwards batching
		Consultingwerk.SmartComponents.Base.SmartDatasetAdapter FindCommitErrorDatasetChildAdapter (RecordIdentifier)	Locates the SmartDatasetAdapter to be used to handle a commit transaction validation error
		Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget FindLinkedUpdatingSmartDataTarget (SmartDatasetAdapter, RecordIdentifier)	Locates the SmartTableIOTarget to be used to handle a commit transaction validation error
		LOGICAL FindRowWhere (character, FindRowWhereModeEnum)	Finds a row in the EntityTable and locates the BindingSource to that row, optionally requesting the record on the server when not found on the client.
		Consultingwerk.SmartComponents.Implementation.SmartBusinessEntityAdapter FromDatasetController (IDatasetController)	Locates the SmartBusinessEntityAdapter instance that is working with the passed in IDatasetController
		HANDLE GetEmptyDataset ()	Retrieves an empty dataset
		CHARACTER GetRecordPosition ()	Evaluates the current record position property value
		Consultingwerk.SmartComponents.Implementation.RetrieveDataStatusEnum GetRetrieveDataStatus ()	Evaluates the status of the current RetrieveData operation
		HandleBufferQuestions (handle)	Handles a SmartUiAction field
		HandleQuestions (handle)	Handles questions retrieved by the backend
		LOGICAL HasPendingTransaction ()	Prompts if pending changes should be saved before retrieving new data
		LOGICAL HasPendingUpdate ()	Prompts if pending update should be saved before retrieving new data, called from RetrieveData
		InitializeAdapter ()	Initializes the SmartBusinessEntityAdapter
		InitializeAdapter (logical)	Initializes the SmartBusinessEntityAdapter
		InitializeServiceAdapter ()	Initializes the ServiceAdapter property of the SmartBusinessEntityAdapter class
		Progress.Lang.Object InvokeMethod (character, dataset-handle, ISerializable)	Invokes a method in the backend OERA business entity
		Progress.Lang.Object InvokeMethod2 (character, dataset-handle, Object)	Invokes a method in the backend OERA business entity
		InvokeParentPositionChanged (Object, EventArgs)	Invokes the ParentPositionChanged event handler in all connected SmartDataAdapter instances
		LaunchDatasetController ()	Launches the DatasetController
		MergeChanges (handle, handle)	Invokes the MERGE-CHANGES after data was submitted to the backend
		Consultingwerk.OERA.IFetchDataRequest NewFetchDataRequest (character, character, character, integer, character)	Factory method for IFetchDataRequest objects
		OffEndHandler (Object, OffEndEventArgs)	Event handler for the OffEnd event of the ProBindingSource object
		OffHome ()	Fetches the Previous Batch of records
		OnAfterAutoCommitTransaction (EventArgs)	Raises the AfterAutoCommitTransaction event
		OnAfterBatchAvailable (EventArgs)	Raises the AfterBatchAvailable event
		OnAfterCommitTransaction (EventArgs)	Raises the AfterCommitTransaction event
		OnAfterGetChanges (AfterGetChangesEventArgs)	Raises the AfterGetChangesEvent
		OnAfterMergeChanges (MergeChangesEventArgs)	Raises the AfterMergeChanges
		OnAfterRejectTransaction (EventArgs)	Raises the AfterRejectTransaction event
		OnAsyncRequestCompleted (EventArgs)	Raises the AsyncRequestCompleted event
		OnAsyncRequestStarted (EventArgs)	Raises the AsyncRequestStarted event
		OnAsyncRequestStarting (CancelableEventArgs)	Raises the AsyncRequestStarting event
		OnAutoCommitChanged (EventArgs)	Raises the AutoCommitChanged property
		OnBeforeCommitTransaction (CancelEventArgs)	Raises the BeforeCommitTransaction event
		OnBeforeGetChanges (BeforeGetChangesEventArgs)	Raises the BeforeGetChangesEvent
		OnBeforeMergeChanges (MergeChangesEventArgs)	Raises the BeforeMergeChanges event
		OnBeforeRejectTransaction (CancelEventArgs)	Raises the BeforeRejectTransaction event
		OnBeforeSubmitChangesToBackend (BeforeSubmitChangesToBackendEventArgs)	Raises the BeforeSubmitChangesToBackend
		OnFindCurrentRecordAfterCommitChanges (BufferHandleEventArgs)	Raises the FindCurrentRecordAfterCommitChanges
		OnFindDataAdapterForCommitErrorHandling (FindDataAdapterForCommitErrorHandlingEventArgs)	Raises the FindDataAdapterForCommitErrorHandling
		OnFindUpdatingTableIOTargetForCommitErrorHandling (FindUpdatingTableIOTargetForCommitErrorHandlingEventArgs)	Raises the FindUpdatingDataTargetForCommitErrorHandling
		OnHandleValidationError (HandleValidationErrorEventArgs)	Raises the HandleValidationError
		OnNewFetchDataRequest (NewFetchDataRequestEventArgs)	Raises the NewFetchDataRequest
		OnSetQueryOpenAfterCommit (SetQueryOpenAfterCommitEventArgs)	Raises the SetQueryOpenAfterCommit
		OnSmartCommitSourceChanged (EventArgs)	Raises the SmartCommitSourceChanged event
		OnSmartTransactionStateChanged (EventArgs)	Raises the SmartTransactionStateChanged event
		OnVerbClicked (character)	Event Handler method for Designer Verbs
		OpenBusinessEntity ()	Opens the Business Entity class in PDSOE
		OpenDataAccess ()	Opens the Data Access class in PDSOE
		PrepareDataBinding ()	Method used to prepare the BindingSource:Handle object (QUERY or ProDataset).
		LOGICAL PreviousBatchAvailable ()	Returns true if a previous batch is available.
		RefetchCurrentRow (character)	Refetches the current row from the backend and merges it with the frontend dataset
		RefetchCurrentRow (handle, character, character)	Refetches the current row from the backend and merges it with the frontend dataset
		RefreshData ()	Refreshes the current data
		RejectTransaction ()	Reverts the changes of a pending transaction
		RepositionAfterUpdateRow (rowid, logical)	Repositions to the updated record after update
		LOGICAL RetrieveData ()	Reads Data from a Datasource and links the DataHandle with a BindingSource inside the Instance of SmartBusinessEntityAdapter. * If there is no valid instance of a BindingSource a new one is created. After that a Dataset is cleared and then filled with the requested data from the Database. Now a Query is build or reopened and the Handle to this Query is assigned to the BindingSource:Handle. * Enforced by Interface ISmartDataSource
		RetrieveData (character, character, IFetchDataRequest, dataset-handle)	Bundles calls to ServiceAdapter:RetrieveData
		ServiceAdapter_RetrieveDataAsyncCompleted (Object, RetrieveDataAsyncCompletedEventArgs)	Handler for the ServiceAdapters RetrieveDataAsyncCompleted event
		SetDefaultStopAfter ()	Sets the values of the StopAfter property from the IConfigurationProvider instance (.applicationsettings)
		SetDesignerProperties ()	Sets properties that affect the Visual Designer
		SetQuerySort (character)	Overridable Setter for QuerySort property
		SetQueryString (character)	Overridable Setter for QueryString property
		SetSavingData (logical)	Assigns the internal flag that data is being saved
		SetSmartDataSource (ISmartDataSource)	SetSmartDataSource sets the SmartDataSource of the current instance of the SmartBusinessEntityAdapter. This Method is called from the Property Setter of SmartDataSource in the Base Class. * Gets the ForeignFields from the hDataset which if not read before is fetched from the Backend. Afterwards the backward handshake with the SmartDataSource is completed and the Handler for the PositionChanged Event is subscribed to be able to recognize that the Parent Data has changed.
		ShowBusinessEntityPickerDialog ()	Shows the Business Entity Selection Dialog during design time
		ShowDatasetControllerDialog ()	Shows Dialog to select a DatasetController from within the OEA/PDSOE Visual Designer
		ShowTablePickerDialog ()	Invokes the Table Picker Dialog and sets properties of the SmartBusinessEntityAdapter during Design Time
		SubmitChanges ()	Creates a dataset containing the modifications of the SmartBusinessEntityAdapter's dataset and submits the changes dataset to the service adapter (and then to the Business Entity).
		SubmitChangesToBackend ()	Creates a dataset containing the modifications of the SmartBusinessEntityAdapter's dataset and submits the changes dataset to the service adapter (and then to the Business Entity).
		LOGICAL ValidateBusinessEntityName (character)	Validates a BusinessEntityName against the Backend.
		VerifyTransactionPending ()	Verifies that after cancelling an update the Transaction State should be PendingChanges

Top Constructor Summary

	Options	Name	Purpose
		SmartBusinessEntityAdapter ()	Constructor for the SmartBusinessEntityAdapter class
		SmartBusinessEntityAdapter (IContainer)	Constructor for the SmartBusinessEntityAdapter class

Top Event Summary

	Options	Name	Purpose
		AfterAutoCommitTransaction DELEGATE System.EventHandler	Raised after an AutoCommit=TRUE transaction has been Committed
		AfterBatchAvailable DELEGATE System.EventHandler	Event fired whenever the SmartDataAdapter has received a new batch of data
		AfterCommitTransaction DELEGATE System.EventHandler	Raised after an AutoCommit=FALSE transaction has been Committed
		AfterGetChanges (Object, AfterGetChangesEventArgs)	Raised before the SmartBusinessEntityAdapter gets the Changes of the ProDataset
		AfterMergeChanges (Object, MergeChangesEventArgs)	Raised after the processed changes from the backend are merged with the local data
		AfterRejectTransaction DELEGATE System.EventHandler	Raised after a transaction has been Rejected
		AsyncRequestCompleted (Object, EventArgs)	Event fired after an asynchronous request has completed
		AsyncRequestStarted (Object, EventArgs)	Event fired when starting an asynchronous request
		AsyncRequestStarting (Object, CancelableEventArgs)	Event fired before starting an asynchronous request
		AutoCommitChanged DELEGATE System.EventHandler	Raised when the AutoCommit property is changed
		BeforeCommitTransaction DELEGATE System.ComponentModel.CancelEventHandler	Raised before a transaction will be committed
		BeforeGetChanges (Object, BeforeGetChangesEventArgs)	Raised before the SmartBusinessEntityAdapter gets the Changes of the ProDataset
		BeforeMergeChanges (Object, MergeChangesEventArgs)	Raised before the processed changes from the backend are merged with the local data
		BeforeRejectTransaction DELEGATE System.ComponentModel.CancelEventHandler	Raised before a transaction will be rejected
		BeforeSubmitChangesToBackend (Object, BeforeSubmitChangesToBackendEventArgs)	Raised before changes are submitted to the Backend
		FindCurrentRecordAfterCommitChanges (Object, BufferHandleEventArgs)	Raised after an AutoCommit=FALSE SmartBusinessEntityAdapter has submitted changes to the backend.
		FindDataAdapterForCommitErrorHandling (Object, FindDataAdapterForCommitErrorHandlingEventArgs)	Raised when CommitTransaction caused a validation error and the SmartBusinessEntityAdapter needs to locate the SmartDatasetChildAdapter to handle the issue
		FindUpdatingTableIOTargetForCommitErrorHandling (Object, FindUpdatingTableIOTargetForCommitErrorHandlingEventArgs)	Raised when CommitTransaction caused a validation error and the SmartBusinessEntityAdapter needs to locate the updating SmartTableIOTarget to handle the issue
		HandleValidationError (Object, HandleValidationErrorEventArgs)	Raised to allow subscribers to handle validations errors caused by a non AutoCommit transaction commit
		NewFetchDataRequest (Object, NewFetchDataRequestEventArgs)	Raised before an actual call to the Service Adapter is made to read data from the backend
		SetQueryOpenAfterCommit (Object, SetQueryOpenAfterCommitEventArgs)	Raised after committing changes to the backend to determine of the SmartBusinessEntityAdapter should be opening it's query (EntityTable) to refresh updates
		SmartCommitSourceChanged DELEGATE System.EventHandler	Event fired whenever the SmartCommitSource property has changed
		SmartTransactionStateChanged DELEGATE System.EventHandler	Event fired whenever the SmartTransactionState property has changed

Top Property Summary

	Options	Name	Purpose
		LOGICAL AutoCommit
		INTEGER BatchSize
		CHARACTER BindTo
		HANDLE ContextDataset
		CHARACTER ContextID
		CHARACTER ContextString
		LOGICAL CopyErrorsIntoDataset
		LOGICAL CreateDistinctBuffer
		CHARACTER CustomContext
		HANDLE DataSet
		Consultingwerk.SmartComponents.Interfaces.IDatasetController DatasetController
		CHARACTER DatasetControllerType
		LOGICAL EmptyDatasetOnRetrieveData
		CHARACTER EntityJoin
		CHARACTER EntityName
		CHARACTER EntityTable
		CHARACTER EntityView
		LOGICAL FetchLastOnServer
		CHARACTER FindString
		Consultingwerk.SmartComponents.Interfaces.Design.IDesignCommitSource LinkCommitSource
		Consultingwerk.OERA.INamedQueryParameter NamedQuery
		CHARACTER NextContext
		LOGICAL PreferNativeSerialization
		INTEGER PrefetchOnFindRowWhere
		CHARACTER PrevContext
		CHARACTER PreviousFetchQueries
		LOGICAL PromptWhenRetrieveDataInUpdateState
		CHARACTER QueryString
		LOGICAL RequestPending
		LOGICAL RetrieveDataAsync
		LOGICAL RetrieveDataOnChangeSortOrder
		LOGICAL RetrieveDataPending
		Progress.Lang.Object SaveChangesParameter
		Consultingwerk.OERA.IServiceAdapter ServiceAdapter
		Consultingwerk.SmartComponents.Interfaces.ISmartCommitSource SmartCommitSource
		Consultingwerk.SmartComponents.Enum.TransactionStateEnum SmartTransactionState
		INTEGER StopAfter

Method Detail

Top

AttachQueryToBindingSource ()

Purpose:	Attaches the Query/ProDataset to the BindingSource
Notes:

Top

BeginTransactionState ()

Purpose:	Begins a transaction when starting update
Notes:	Allows SmartDatasetChildAdapter to initiate TransactionState in a
	parent SmartBusinessEntityAdapter

Top

ClearQuestions (handle)

Purpose:	Clears the questions
Notes:

Parameters:
phDataset	HANDLE
	The dataset to clear

Top

CloseQuery ()

Purpose:	Empty the DATASET inside the DataAdapter and reopen Query.
Notes:

Top

LOGICAL CommitTransaction ()

Purpose:	Commits the transaction to the backend
Notes:	See http://jira.consultingwerkcloud.com/browse/SCL-407 for details
	on how errors are handled

Returns	LOGICAL
	Logical value indicating if the operation was successful

Top

CopyErrorsIntoDataset (handle)

Purpose:	Copies the errors from the changes dataset into the dataset of he
	SmartBusinessEntityAdapter instance
Notes:

Parameters:
phChangesDataset	HANDLE
	The handle of the dataset with the changes

Top

EmptyDataset ()

Purpose:	Empties the ProDataset
Notes:	Only supported when EmptyDatasetOnRetrieveData = FALSE

Top

EndInit ()

Purpose:	Executed at the end of the initialization of the
	SmartBusinessEntityAdapter to launch the DatasetController (if any).
Notes:

Top

EndUpdateState (ISmartDataTarget)

Purpose:	The Message to for instance enable a Browser is send to all
	SmartDataTargets except the calling one.
Notes:	This Method is called from the SmartViewerControl derived Class when
	starting to Modify or Add data.
	Enforced by Interface ISmartDataSource.

Parameters:
poSmartDataTarget	Consultingwerk.SmartComponents.Interfaces.ISmartDataTarget
	The reference to the ISmartDataTarget that ends the UpdateState

Top

EndUpdateStateInDataSource (ISmartDataTarget)

Purpose:	Invokes EndUpdateState in the SmartDataSource of this SmartDataAdapter
Notes:	Suspends the call to EndUpdateState when there is a pending transaction

Parameters:
poSmartDataTarget	Consultingwerk.SmartComponents.Interfaces.ISmartDataTarget
	The reference to the ISmartDataTarget that ends the UpdateState

Top

CHARACTER EvaluateParentQueryAfterUpdate ()

Purpose:	Evaluates the QueryString based on the Parent Filter Fields after
	UpdateRow
Notes:	The SmartDatasetChildAdapter and the SmartBusinessEntityAdapter
	require a different implementation here

Returns	CHARACTER
	The parent filter query string

Top

LOGICAL FetchAll ()

Purpose:	Fetches all remaining data from the backend
Notes:

Returns	LOGICAL
	Logical value indicating if more rows have been fetched

Top

LOGICAL FetchFirst ()

Purpose:	Overrides FetchFirst in SmartDataAdapter. Retrieves the first batch
	of records when backwards batching
Notes:	Method enforced by ISmartNavigationTarget

Returns	LOGICAL
	Logical value indicating if the operation was successful

Top

LOGICAL FetchLast ()

Purpose:	Overrides FetchLast in SmartDataAdapter to retrieve full business
	entity result when batching.
Notes:	Method enforced by ISmartNavigationTarget

Returns	LOGICAL
	Logical value indicating if the operation was successful

Top

FetchLastOnServer ()

Purpose:	Fetch Last On Server, used by FetchLast when FetchLastOnServer = TRUE
Notes:

Top

FetchMoreRowsForwards (integer)

Purpose:	Fetches additional rows forwards
Notes:	Useful to fill up the Dataset for data export operations (Excel Export)
	When we are actually backwards-batching we will start fetching the
	number of rows forward

Parameters:
piNumRows	INTEGER
	The number of rows to fetch forwards

Top

LOGICAL FetchPrev ()

Purpose:	Overrides FetchPrev in SmartDataAdapter. Retrieves the previous batch
	of records when backwards batching
Notes:	Method enforced by ISmartNavigationTarget

Returns	LOGICAL
	Logical value indicating if the operation was successful

Top

Consultingwerk.SmartComponents.Base.SmartDatasetAdapter FindCommitErrorDatasetChildAdapter (RecordIdentifier)

Purpose:	Locates the SmartDatasetAdapter to be used to handle a commit transaction
	validation error
Notes:

Parameters:
poRecordIdentifier	Consultingwerk.RecordIdentifier
	The Record Identifier describing the record that caused the validation error
Returns	Consultingwerk.SmartComponents.Base.SmartDatasetAdapter
	The updating SmartTableIOTarget used to handle the error (may be unknown)

Top

Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget FindLinkedUpdatingSmartDataTarget (SmartDatasetAdapter, RecordIdentifier)

Purpose:	Locates the SmartTableIOTarget to be used to handle a commit transaction
	validation error
Notes:

Parameters:
poAdapter	Consultingwerk.SmartComponents.Base.SmartDatasetAdapter
	The SmartDatasetAdapter that is used to handle the error
poRecordIdentifier	Consultingwerk.RecordIdentifier
	The Record Identifier describing the record that caused the validation error
Returns	Consultingwerk.SmartComponents.Interfaces.ISmartTableIOTarget
	The updating SmartTableIOTarget used to handle the error (may be unknown)

Top

LOGICAL FindRowWhere (character, FindRowWhereModeEnum)

Purpose:	Finds a row in the EntityTable and locates the BindingSource
	to that row, optionally requesting the record on the server
	when not found on the client.
Notes:	Overloads FindRowWhere (pcFindString) in SmartDatasetAdapter
	The record is actually located using a dynamic query instead of a
	FIND so that sorting is also supported (typically sorting should
	be passed in with the same value as the QuerySort property of
	this SmartBusinessEntityAdapter instance
	When FindRowWhere (FindRowWhereModeEnum:FindOnServer) is called before
	any previous invocation of RetrieveData if will act like FindRowWhere
	(FindOnServerOnly).
	A FindRowWhere (FindOnClient) is called before any previous invocation
	of RetrieveData an error message is raised.

Parameters:
pcFindString	CHARACTER
	The find criteria, optionally including a sort phrase (BY)
poFindMode	Consultingwerk.SmartComponents.Enum.FindRowWhereModeEnum
	The FindRowWhereModeEnum value indicating if the search should be done on the client first, client then server or server only
Returns	LOGICAL
	Logical value indicating if a record was found

Top

Consultingwerk.SmartComponents.Implementation.SmartBusinessEntityAdapter FromDatasetController (IDatasetController)

Purpose:	Locates the SmartBusinessEntityAdapter instance that is working
	with the passed in IDatasetController
Notes:	This method may be removed using the NoStaticsInHybrids setting
	in Consultingwerk/products.i. This allows to avoid static members
	in hybrid classes SmartDataBrowser and SmartBusinessEntityAdapter
	to avoid issues with the combination of static and hybrids on 11.2
	and 11.3, OE defect OE00240707 http://knowledgebase.progress.com/articles/Article/000042229?popup=true

Parameters:
poDatasetController	Consultingwerk.SmartComponents.Interfaces.IDatasetController
	The IDatasetController instance that was launched by a SmartBusinessEntityAdapter
Returns	Consultingwerk.SmartComponents.Implementation.SmartBusinessEntityAdapter
	The SmartBusinessEntityAdapter that has launched the IDatasetController or the unknown value

Top

HANDLE GetEmptyDataset ()

Purpose:	Retrieves an empty dataset
Notes:	Used in the GET implementation of the DataSet property
	This dataset can be used to bind UI components to before calling
	RetrieveData

Returns	HANDLE
	The handle of the empty ProDataset

Top

CHARACTER GetRecordPosition ()

Purpose:	Evaluates the current record position property value
Notes:	Overrides standard implementation in SmartDataAdapter to allow
	Backwards Batching

Returns	CHARACTER
	The current record position as a CHARACTER representing an RecordPositionEnum value

Top

Consultingwerk.SmartComponents.Implementation.RetrieveDataStatusEnum GetRetrieveDataStatus ()

Purpose:	Evaluates the status of the current RetrieveData operation
Notes:	NotBatching / BackwardsBatching / ForwardBatching

Returns	Consultingwerk.SmartComponents.Implementation.RetrieveDataStatusEnum
	The RetrieveDataStatusEnum value that describes the current data status

Top

HandleBufferQuestions (handle)

Purpose:	Handles a SmartUiAction field
Notes:	Callback method for the SmartUiActionQuestionWalker class

Parameters:
phBuffer	HANDLE
	The handle of a buffer with the SmartUiAction field

Top

HandleQuestions (handle)

Purpose:	Handles questions retrieved by the backend
Notes:

Parameters:
phChangesDataset	HANDLE
	The dataset with processed changes retrieved from the backend

Top

LOGICAL HasPendingTransaction ()

Purpose:	Prompts if pending changes should be saved before retrieving new
	data
Notes:

Returns	LOGICAL
	Logical value indicating if we still have a pending transaction

Top

LOGICAL HasPendingUpdate ()

Purpose:	Prompts if pending update should be saved before retrieving new
	data, called from RetrieveData
Notes:	Only used when property PromptWhenRetrieveDataInUpdateState = TRUE

Returns	LOGICAL
	Logical value indicating if RetrieveData should be cancelled

Top

InitializeAdapter ()

Purpose:	Initializes the SmartBusinessEntityAdapter
Notes:	Useful to initialize the BindingSource and Query before calling
	RetrieveData. Defaults to InitializeAdapter(TRUE) to empty the
	dataset
	It's not recommended to call this method prior to the Form's OnLoad
	or OnShown event as the ProBindingSource seems to reset the Handle
	Property (Query or Dataset) that was assigned to early during
	initialization

Top

InitializeAdapter (logical)

Purpose:	Initializes the SmartBusinessEntityAdapter
Notes:	Useful to initialize the BindingSource and Query before calling
	RetrieveData. When the dataset requirers to be emptied, we need need
	to turn off tracking-changes.
	It's not recommended to call this method prior to the Form's OnLoad
	or OnShown event as the ProBindingSource seems to reset the Handle
	Property (Query or Dataset) that was assigned to early during
	initialization

Parameters:
plEmptyDataset	LOGICAL
	Logical flag to indicate if the dataset should be emptied or not.

Top

InitializeServiceAdapter ()

Purpose:	Initializes the ServiceAdapter property of the SmartBusinessEntityAdapter
	class
Notes:	Invoked by the constructor, defaults to FrameworkSettings:ServiceAdapter but
	allows for customization in a child class

Top

Progress.Lang.Object InvokeMethod (character, dataset-handle, ISerializable)

Purpose:	Invokes a method in the backend OERA business entity
Notes:

Parameters:
pcMethodName	CHARACTER
	The method to be invoked in the Business Entity
phDataset	DATASET-HANDLE
	INPUT-OUTPUT DATASET-HANDLE The handle of the dataset to be passed to the Business Entity method
poParameter	Consultingwerk.ISerializable
	The ISerializable parameter object to be passed to the Business Entity method
Returns	Progress.Lang.Object
	The instance of the parameter object

Top

Progress.Lang.Object InvokeMethod2 (character, dataset-handle, Object)

Purpose:	Invokes a method in the backend OERA business entity
Notes:	This variant of InvokeMethod2 uses the native ABL-SERIALIZABLE method
	for exchanging the parameter object with the backend. It does however
	return a different instance of the parameter object, so the unlike in
	InvokeMethod() the instance passed in as the poParameter reference is
	not updated with data from the backend. Thus we're introducing the
	return value to return the updated parameter object from the backend.

Parameters:
pcMethodName	CHARACTER
	The method to be invoked in the Business Entity
phDataset	DATASET-HANDLE
	INPUT-OUTPUT DATASET-HANDLE The handle of the dataset to be passed to the Business Entity method
poParameter	Progress.Lang.Object
	The ISerializable parameter object to be passed to the Business Entity method
Returns	Progress.Lang.Object
	The instance of the parameter object

Top

InvokeParentPositionChanged (Object, EventArgs)

Purpose:	Invokes the ParentPositionChanged event handler in all connected
	SmartDataAdapter instances
Notes:	SCL-402: Clears pending cPreviousFetchQueryString in linked
	SmartDatasetChildAdapter instances

Parameters:
sender	System.Object
	The reference to the sender associated with the event
e	System.EventArgs
	The reference to the System.EventArgs with the data for the event

Top

LaunchDatasetController ()

Purpose:	Launches the DatasetController
Notes:	Throws an error when the DatasetController is already running.

Top

MergeChanges (handle, handle)

Purpose:	Invokes the MERGE-CHANGES after data was submitted to the backend
Notes:

Parameters:
phChangesDataset	HANDLE
	The handle of the dataset with the changes returned back from the backend
phDataset	HANDLE
	The handle of the dataset to merge the changes into

Top

Consultingwerk.OERA.IFetchDataRequest NewFetchDataRequest (character, character, character, integer, character)

Purpose:	Factory method for IFetchDataRequest objects
Notes:	Allows creation of alternative implementations of IFetchDataRequest
	Used by RetrieveData and OffEndHandler in preparation of calls to
	the ServiceAdapter

Parameters:
pcTables	CHARACTER
	The tables to be requested
pcQueries	CHARACTER
	The queries to be requested
pcRequests	CHARACTER
	The requests parameter
piNumRecords	INTEGER
	The number of records to be requested
pcContext	CHARACTER
	The context to be passed to the Business Entity
Returns	Consultingwerk.OERA.IFetchDataRequest
	The new IFetchDataRequest instance

Top

OffEndHandler (Object, OffEndEventArgs)

Purpose:	Event handler for the OffEnd event of the ProBindingSource object
Notes:	Overrides OffEndHandler in SmartDataAdapter base class
	OffEndHandler does not support asynchronous FetchData

Parameters:
sender	System.Object
	The reference to the object that raised the event
e	Progress.Data.OffEndEventArgs
	The OffEndEventArgs with the data for the event

Top

OffHome ()

Purpose:	Fetches the Previous Batch of records
Notes:

Top

OnAfterAutoCommitTransaction (EventArgs)

Purpose:	Raises the AfterAutoCommitTransaction event
Notes:

Parameters:
e	System.EventArgs
	A System.EventArgs with the Event-Data

Top

OnAfterBatchAvailable (EventArgs)

Purpose:	Raises the AfterBatchAvailable event
Notes:

Parameters:
e	System.EventArgs
	The System.EventArgs with the data for this event

Top

OnAfterCommitTransaction (EventArgs)

Purpose:	Raises the AfterCommitTransaction event
Notes:

Parameters:
e	System.EventArgs
	A System.EventArgs with the Event-Data

Top

OnAfterGetChanges (AfterGetChangesEventArgs)

Purpose:	Raises the AfterGetChangesEvent
Notes:

Parameters:
e	Consultingwerk.SmartComponents.Implementation.AfterGetChangesEventArgs
	The AfterGetChangesEventArgs with the data for this event

Top

OnAfterMergeChanges (MergeChangesEventArgs)

Purpose:	Raises the AfterMergeChanges
Notes:

Parameters:
e	Consultingwerk.SmartComponents.Implementation.MergeChangesEventArgs
	The MergeChangesEventArgs with the data for the event

Top

OnAfterRejectTransaction (EventArgs)

Purpose:	Raises the AfterRejectTransaction event
Notes:

Parameters:
e	System.EventArgs
	A System.EventArgs with the Event-Data

Top

OnAsyncRequestCompleted (EventArgs)

Purpose:	Raises the AsyncRequestCompleted event
Notes:

Parameters:
e	Consultingwerk.EventArgs
	The EventArgs with the data for the event

Top

OnAsyncRequestStarted (EventArgs)

Purpose:	Raises the AsyncRequestStarted event
Notes:

Parameters:
e	Consultingwerk.EventArgs
	The EventArgs with the data for the event

Top

OnAsyncRequestStarting (CancelableEventArgs)

Purpose:	Raises the AsyncRequestStarting event
Notes:

Parameters:
e	Consultingwerk.CancelableEventArgs
	The CancelableEventArgs with the data for the event

Top

OnAutoCommitChanged (EventArgs)

Purpose:	Raises the AutoCommitChanged property
Notes:

Parameters:
e	System.EventArgs
	The System.EventArgs with the data for this event

Top

OnBeforeCommitTransaction (CancelEventArgs)

Purpose:	Raises the BeforeCommitTransaction event
Notes:

Parameters:
e	System.ComponentModel.CancelEventArgs
	The CancelEventArgs with the data for this event

Top

OnBeforeGetChanges (BeforeGetChangesEventArgs)

Purpose:	Raises the BeforeGetChangesEvent
Notes:

Parameters:
e	Consultingwerk.SmartComponents.Implementation.BeforeGetChangesEventArgs
	The BeforeGetChangesEventArgs with the data for this event

Top

OnBeforeMergeChanges (MergeChangesEventArgs)

Purpose:	Raises the BeforeMergeChanges event
Notes:

Parameters:
e	Consultingwerk.SmartComponents.Implementation.MergeChangesEventArgs
	The MergeChangesEventArgs with the data for the event

Top

OnBeforeRejectTransaction (CancelEventArgs)

Purpose:	Raises the BeforeRejectTransaction event
Notes:

Parameters:
e	System.ComponentModel.CancelEventArgs
	The CancelEventArgs with the data for this event

Top

OnBeforeSubmitChangesToBackend (BeforeSubmitChangesToBackendEventArgs)

Purpose:	Raises the BeforeSubmitChangesToBackend
Notes:

Parameters:
e	Consultingwerk.SmartComponents.Implementation.BeforeSubmitChangesToBackendEventArgs
	The BeforeSubmitChangesToBackendEventArgs with the data for the event

Top

OnFindCurrentRecordAfterCommitChanges (BufferHandleEventArgs)

Purpose:	Raises the FindCurrentRecordAfterCommitChanges
Notes:

Parameters:
e	Consultingwerk.SmartComponents.Base.BufferHandleEventArgs
	The BufferHandleEventArgs with the data for the event

Top

OnFindDataAdapterForCommitErrorHandling (FindDataAdapterForCommitErrorHandlingEventArgs)

Purpose:	Raises the FindDataAdapterForCommitErrorHandling
Notes:

Parameters:
e	Consultingwerk.SmartComponents.Implementation.FindDataAdapterForCommitErrorHandlingEventArgs
	The FindDataAdapterForCommitErrorHandlingEventArgs with the data for the event

Top

OnFindUpdatingTableIOTargetForCommitErrorHandling (FindUpdatingTableIOTargetForCommitErrorHandlingEventArgs)

Purpose:	Raises the FindUpdatingDataTargetForCommitErrorHandling
Notes:

Parameters:
e	Consultingwerk.SmartComponents.Implementation.FindUpdatingTableIOTargetForCommitErrorHandlingEventArgs
	The FindUpdatingDataTargetForCommitErrorHandlingEventArgs with the data for the event

Top

OnHandleValidationError (HandleValidationErrorEventArgs)

Purpose:	Raises the HandleValidationError
Notes:

Parameters:
e	Consultingwerk.SmartComponents.Implementation.HandleValidationErrorEventArgs
	The HandleValidationErrorEventArgs with the data for the event

Top

OnNewFetchDataRequest (NewFetchDataRequestEventArgs)

Purpose:	Raises the NewFetchDataRequest
Notes:

Parameters:
e	Consultingwerk.SmartComponents.Implementation.NewFetchDataRequestEventArgs
	The NewFetchDataRequestEventArgs with the data for the event

Top

OnSetQueryOpenAfterCommit (SetQueryOpenAfterCommitEventArgs)

Purpose:	Raises the SetQueryOpenAfterCommit
Notes:

Parameters:
e	Consultingwerk.SmartComponents.Implementation.SetQueryOpenAfterCommitEventArgs
	The SetQueryOpenAfterCommitEventArgs with the data for the event

Top

OnSmartCommitSourceChanged (EventArgs)

Purpose:	Raises the SmartCommitSourceChanged event
Notes:

Parameters:
e	System.EventArgs
	The System.EventArgs with the data for this event

Top

OnSmartTransactionStateChanged (EventArgs)

Purpose:	Raises the SmartTransactionStateChanged event
Notes:

Parameters:
e	System.EventArgs
	The System.EventArgs with the data for this event

Top

OnVerbClicked (character)

Purpose:	Event Handler method for Designer Verbs
Notes:

Parameters:
pcVerbText	CHARACTER
	The name (Label) of the Designer Verb that was invoked

Top

OpenBusinessEntity ()

Purpose:	Opens the Business Entity class in PDSOE
Notes:

Top

OpenDataAccess ()

Purpose:	Opens the Data Access class in PDSOE
Notes:

Top

PrepareDataBinding ()

Purpose:	Method used to prepare the BindingSource:Handle object (QUERY or ProDataset).
Notes:	Implemented in the SmartBusinessEntityAdapter and SmartDatasetChildAdapter
	Called from RetrieveData or CreateRecord (when called before RetrieveData)

Top

LOGICAL PreviousBatchAvailable ()

Purpose:	Returns true if a previous batch is available.
Notes:

Returns	LOGICAL
	Logical value indicating if a previous batch is available

Top

RefetchCurrentRow (character)

Purpose:	Refetches the current row from the backend and merges it with the
	frontend dataset
Notes:	The pcViewTables parameter is evaluated as the Tables parameter of
	the FetchDataRequest class

Parameters:
pcViewTables	CHARACTER
	The comma delimited list of tables to refetch in addition to the EntityTable

Top

RefetchCurrentRow (handle, character, character)

Purpose:	Refetches the current row from the backend and merges it with the
	frontend dataset
Notes:	This variant of the method is intended to be PACKAGE-PROTECTED (OpenEdge 12)
	It should not be considered part of the public contract

Parameters:
phEntityTableBuffer	HANDLE
	The entity table buffer
pcViewTables	CHARACTER
	The comma delimited list of tables to refetch in addition to the EntityTable
pcFindString	CHARACTER
	The query string for the current record

Top

RefreshData ()

Purpose:	Refreshes the current data
Notes:

Top

RejectTransaction ()

Purpose:	Reverts the changes of a pending transaction
Notes:

Top

RepositionAfterUpdateRow (rowid, logical)

Purpose:	Repositions to the updated record after update
Notes:

Parameters:
proRowid	ROWID
	The rowid of the record to position to
plCreated	LOGICAL
	Logical value indicating if the current record was created

Top

LOGICAL RetrieveData ()

Purpose:	Reads Data from a Datasource and links the DataHandle
	with a BindingSource inside the Instance of SmartBusinessEntityAdapter.
	If there is no valid instance of a BindingSource a new one is created.
	After that a Dataset is cleared and then filled with the requested
	data from the Database. Now a Query is build or reopened and the
	Handle to this Query is assigned to the BindingSource:Handle.
	Enforced by Interface ISmartDataSource
Notes:	Do NOT call SUPER:RetrieveData() in the overriding method.
	Remember to test if a BindingSource exists. If not call
	CreateBindingSource from the base class.

Returns	LOGICAL
	Logical value indicating the success of the method

Top

RetrieveData (character, character, IFetchDataRequest, dataset-handle)

Purpose:	Bundles calls to ServiceAdapter:RetrieveData
Notes:	Simplifies modifications on the ServiceAdapter / ServiceInterface
	as we can centrally add or modify parameters

Parameters:
pcPartition	CHARACTER
	The AppServer partition to be used for this call
pcEntity	CHARACTER
	The name of the Business Entity
poFetchDataRequest	Consultingwerk.OERA.IFetchDataRequest
	The IFetchDataRequest with the parameter for this call
phDataSet	DATASET-HANDLE
	OUTPUT DATASET-HANDLE The result set

Top

ServiceAdapter_RetrieveDataAsyncCompleted (Object, RetrieveDataAsyncCompletedEventArgs)

Purpose:	Handler for the ServiceAdapters RetrieveDataAsyncCompleted event
Notes:

Parameters:
sender	Progress.Lang.Object
	The object that raised the RetrieveDataAsyncCompleted event
e	Consultingwerk.OERA.RetrieveDataAsyncCompletedEventArgs
	The RetrieveDataAsyncCompletedEventArgs with the data for the event

Top

SetDefaultStopAfter ()

Purpose:	Sets the values of the StopAfter property from the IConfigurationProvider
	instance (.applicationsettings)
Notes:

Top

SetDesignerProperties ()

Purpose:	Sets properties that affect the Visual Designer
Notes:

Top

SetQuerySort (character)

Purpose:	Overridable Setter for QuerySort property
Notes:

Parameters:
arg	CHARACTER
	The new value for the QuerySort property

Top

SetQueryString (character)

Purpose:	Overridable Setter for QueryString property
Notes:	Resets the FetchQueryString property to empty string, so that the
	RetrieveData method rebuilds the FetchQueryString by concatenating
	QueryString and QuerySort

Parameters:
arg	CHARACTER
	The new value for the QueryString property

Top

SetSavingData (logical)

Purpose:	Assigns the internal flag that data is being saved
Notes:	Enforced by ISupportsSubmitChanges

Parameters:
plSaving	LOGICAL
	The new value for the flag that data is being saved

Top

SetSmartDataSource (ISmartDataSource)

Purpose:	SetSmartDataSource sets the SmartDataSource of the current instance
	of the SmartBusinessEntityAdapter.
	This Method is called from the Property Setter of SmartDataSource in
	the Base Class.
	Gets the ForeignFields from the hDataset which if not read before is
	fetched from the Backend. Afterwards the backward handshake with the
	SmartDataSource is completed and the Handler for the PositionChanged
	Event is subscribed to be able to recognize that the Parent Data has
	changed.
Notes:	You do not need to call SetSmartDataSource () in the overriding method.

Parameters:
arg	Consultingwerk.SmartComponents.Interfaces.ISmartDataSource
	The SmartDataSource for this instance

Top

ShowBusinessEntityPickerDialog ()

Purpose:	Shows the Business Entity Selection Dialog during design time
Notes:

Top

ShowDatasetControllerDialog ()

Purpose:	Shows Dialog to select a DatasetController from within the
	OEA/PDSOE Visual Designer
Notes:	Stores the chosen class name in the DatasetControllerType property

Top

ShowTablePickerDialog ()

Purpose:	Invokes the Table Picker Dialog and sets properties of the
	SmartBusinessEntityAdapter during Design Time
Notes:	Only intended for DesignTime

Top

SubmitChanges ()

Purpose:	Creates a dataset containing the modifications of the
	SmartBusinessEntityAdapter's dataset and submits the changes dataset
	to the service adapter (and then to the Business Entity).
Notes:	Used from UpdateRow after every modification from the UI.

Top

SubmitChangesToBackend ()

Purpose:	Creates a dataset containing the modifications of the
	SmartBusinessEntityAdapter's dataset and submits the changes dataset
	to the service adapter (and then to the Business Entity).
Notes:	Used from UpdateRow after every modification from the UI.

Top

LOGICAL ValidateBusinessEntityName (character)

Purpose:	Validates a BusinessEntityName against the Backend.
Notes:	This method is intended to be overridden by different backend
	adapters (i.e. ticEnterprise)

Parameters:
pcEntityName	CHARACTER
	The name of the Business Entity
Returns	LOGICAL
	Logical value indicating if the business entity name is valid

Top

VerifyTransactionPending ()

Purpose:	Verifies that after cancelling an update the Transaction State
	should be PendingChanges
Notes:	Tests if the ProDataset actually has changes or any of the
	SmartDatasetChildAdapters are ModifyingData

Constructor Detail

Top

SmartBusinessEntityAdapter ()

Purpose:	Constructor for the SmartBusinessEntityAdapter class
Notes:

Top

SmartBusinessEntityAdapter (IContainer)

Purpose:	Constructor for the SmartBusinessEntityAdapter class
Notes:

Parameters:
poContainer	System.ComponentModel.IContainer
	The IContainer to add the SmartBusinessEntityAdapter to.

Event Detail

Top

AfterAutoCommitTransaction DELEGATE System.EventHandler

Purpose:	Raised after an AutoCommit=TRUE transaction has been Committed
Notes:

Delegate: System.EventHandler

Top

AfterBatchAvailable DELEGATE System.EventHandler

Purpose:	Event fired whenever the SmartDataAdapter has received a new batch
	of data
Notes:	This event will be raised also with the initial batch of data (when
	the AfterReviewData event is raised as well)

Delegate: System.EventHandler

Top

AfterCommitTransaction DELEGATE System.EventHandler

Purpose:	Raised after an AutoCommit=FALSE transaction has been Committed
Notes:

Delegate: System.EventHandler

Top

AfterGetChanges (Object, AfterGetChangesEventArgs)

Purpose:	Raised before the SmartBusinessEntityAdapter gets the Changes of the ProDataset
Notes:	The AfterGetChanges Event allows manipulation of the Changes dataset
	on the client after it has been populated using the GET-CHANGES method

Parameters:
sender	Progress.Lang.Object
	The reference to the object that raised the event
e	Consultingwerk.SmartComponents.Implementation.AfterGetChangesEventArgs
	The AfterGetChangesEventArgs with the data for this event

Top

AfterMergeChanges (Object, MergeChangesEventArgs)

Purpose:	Raised after the processed changes from the backend are merged with
	the local data
Notes:

Parameters:
sender	System.Object
	The object that raised the AfterMergeChanges event
e	Consultingwerk.SmartComponents.Implementation.MergeChangesEventArgs
	The MergeChangesEventArgs with the data for the event

Top

AfterRejectTransaction DELEGATE System.EventHandler

Purpose:	Raised after a transaction has been Rejected
Notes:

Delegate: System.EventHandler

Top

AsyncRequestCompleted (Object, EventArgs)

Purpose:	Event fired after an asynchronous request has completed
Notes:

Parameters:
sender	Progress.Lang.Object
	The object that raised the AsyncRequestCompleted event
e	Consultingwerk.EventArgs
	The EventArgs with the data for the event

Top

AsyncRequestStarted (Object, EventArgs)

Purpose:	Event fired when starting an asynchronous request
Notes:

Parameters:
sender	Progress.Lang.Object
	The object that raised the AsyncRequestStarted event
e	Consultingwerk.EventArgs
	The EventArgs with the data for the event

Top

AsyncRequestStarting (Object, CancelableEventArgs)

Purpose:	Event fired before starting an asynchronous request
Notes:

Parameters:
sender	Progress.Lang.Object
	The object that raised the AsyncRequestStarting event
e	Consultingwerk.CancelableEventArgs
	The CancelableEventArgs with the data for the event

Top

AutoCommitChanged DELEGATE System.EventHandler

Purpose:	Raised when the AutoCommit property is changed
Notes:	Required for ISmartCommitTarget

Delegate: System.EventHandler

Top

BeforeCommitTransaction DELEGATE System.ComponentModel.CancelEventHandler

Purpose:	Raised before a transaction will be committed
Notes:

Delegate: System.ComponentModel.CancelEventHandler

Top

BeforeGetChanges (Object, BeforeGetChangesEventArgs)

Purpose:	Raised before the SmartBusinessEntityAdapter gets the Changes of the ProDataset
Notes:	The BeforeGetChanges Event allows manipulation of the Data on the client
	prior to calling the GET-CHANGES method on the Dataset

Parameters:
sender	Progress.Lang.Object
	The reference to the object that raised the event
e	Consultingwerk.SmartComponents.Implementation.BeforeGetChangesEventArgs
	The BeforeGetChangesEventArgs with the data for this event

Top

BeforeMergeChanges (Object, MergeChangesEventArgs)

Purpose:	Raised before the processed changes from the backend are merged with
	the local data
Notes:

Parameters:
sender	System.Object
	The object that raised the BeforeMergeChanges event
e	Consultingwerk.SmartComponents.Implementation.MergeChangesEventArgs
	The MergeChangesEventArgs with the data for the event

Top

BeforeRejectTransaction DELEGATE System.ComponentModel.CancelEventHandler

Purpose:	Raised before a transaction will be rejected
Notes:

Delegate: System.ComponentModel.CancelEventHandler

Top

BeforeSubmitChangesToBackend (Object, BeforeSubmitChangesToBackendEventArgs)

Purpose:	Raised before changes are submitted to the Backend
Notes:	Cancelable Event

Parameters:
sender	Progress.Lang.Object
	The object that raised the BeforeSubmitChangesToBackend event
e	Consultingwerk.SmartComponents.Implementation.BeforeSubmitChangesToBackendEventArgs
	The BeforeSubmitChangesToBackendEventArgs with the data for the event

Top

FindCurrentRecordAfterCommitChanges (Object, BufferHandleEventArgs)

Purpose:	Raised after an AutoCommit=FALSE SmartBusinessEntityAdapter has submitted
	changes to the backend.
Notes:	Allows developers to influence the record to which the
	SmartBusinessEntityAdapter and linked SmartDataBrowsers should be located
	after the commit operation

Parameters:
sender	Progress.Lang.Object
	The object that raised the FindCurrentRecordAfterCommitChanges event
e	Consultingwerk.SmartComponents.Base.BufferHandleEventArgs
	The BufferHandleEventArgs with the data for the event

Top

FindDataAdapterForCommitErrorHandling (Object, FindDataAdapterForCommitErrorHandlingEventArgs)

Purpose:	Raised when CommitTransaction caused a validation error and the
	SmartBusinessEntityAdapter needs to locate the SmartDatasetChildAdapter
	to handle the issue
Notes:	Allows reopening a child-form that may be required because it contains
	the SmartDatasetChildAdapter

Parameters:
sender	Progress.Lang.Object
	The object that raised the FindDataAdapterForCommitErrorHandling event
e	Consultingwerk.SmartComponents.Implementation.FindDataAdapterForCommitErrorHandlingEventArgs
	The FindDataAdapterForCommitErrorHandlingEventArgs with the data for the event

Top

FindUpdatingTableIOTargetForCommitErrorHandling (Object, FindUpdatingTableIOTargetForCommitErrorHandlingEventArgs)

Purpose:	Raised when CommitTransaction caused a validation error and the
	SmartBusinessEntityAdapter needs to locate the updating SmartTableIOTarget
	to handle the issue
Notes:	Allows reopening a child-form that may be required because it contains
	the SmartDatasetChildAdapter

Parameters:
sender	Progress.Lang.Object
	The object that raised the FindUpdatingDataTargetForCommitErrorHandling event
e	Consultingwerk.SmartComponents.Implementation.FindUpdatingTableIOTargetForCommitErrorHandlingEventArgs
	The FindUpdatingDataTargetForCommitErrorHandlingEventArgs with the data for the event

Top

HandleValidationError (Object, HandleValidationErrorEventArgs)

Purpose:	Raised to allow subscribers to handle validations errors caused by
	a non AutoCommit transaction commit
Notes:	Set the e:Handled = TRUE to avoid error handling by the SmartBusinessEntityAdapter
	instance

Parameters:
sender	Progress.Lang.Object
	The object that raised the HandleValidationError event
e	Consultingwerk.SmartComponents.Implementation.HandleValidationErrorEventArgs
	The HandleValidationErrorEventArgs with the data for the event

Top

NewFetchDataRequest (Object, NewFetchDataRequestEventArgs)

Purpose:	Raised before an actual call to the Service Adapter is made to read
	data from the backend
Notes:	Allows modification of the FetchDataRequest object

Parameters:
sender	Progress.Lang.Object
	The object that raised the NewFetchDataRequest event
e	Consultingwerk.SmartComponents.Implementation.NewFetchDataRequestEventArgs
	The NewFetchDataRequestEventArgs with the data for the event

Top

SetQueryOpenAfterCommit (Object, SetQueryOpenAfterCommitEventArgs)

Purpose:	Raised after committing changes to the backend to determine of the
	SmartBusinessEntityAdapter should be opening it's query (EntityTable)
	to refresh updates
Notes:

Parameters:
sender	Progress.Lang.Object
	The object that raised the SetQueryOpenAfterCommit event
e	Consultingwerk.SmartComponents.Implementation.SetQueryOpenAfterCommitEventArgs
	The SetQueryOpenAfterCommitEventArgs with the data for the event

Top

SmartCommitSourceChanged DELEGATE System.EventHandler

Purpose:	Event fired whenever the SmartCommitSource property has
	changed
Notes:

Delegate: System.EventHandler

Top

SmartTransactionStateChanged DELEGATE System.EventHandler

Purpose:	Event fired whenever the SmartTransactionState property has
	changed
Notes:

Delegate: System.EventHandler

Property Detail

Top

LOGICAL AutoCommit

Returns	LOGICAL

Top

INTEGER BatchSize

Returns	INTEGER

Top

CHARACTER BindTo

Returns	CHARACTER

Top

HANDLE ContextDataset

Returns	HANDLE

Top

CHARACTER ContextID

Returns	CHARACTER

Top

CHARACTER ContextString

Returns	CHARACTER

Top

LOGICAL CopyErrorsIntoDataset

Returns	LOGICAL

Top

LOGICAL CreateDistinctBuffer

Returns	LOGICAL

Top

CHARACTER CustomContext

Returns	CHARACTER

Top

HANDLE DataSet

Returns	HANDLE

Top

Consultingwerk.SmartComponents.Interfaces.IDatasetController DatasetController

Returns	Consultingwerk.SmartComponents.Interfaces.IDatasetController

Top

CHARACTER DatasetControllerType

Returns	CHARACTER

Top

LOGICAL EmptyDatasetOnRetrieveData

Returns	LOGICAL

Top

CHARACTER EntityJoin

Returns	CHARACTER

Top

CHARACTER EntityName

Returns	CHARACTER

Top

CHARACTER EntityTable

Returns	CHARACTER

Top

CHARACTER EntityView

Returns	CHARACTER

Top

LOGICAL FetchLastOnServer

Returns	LOGICAL

Top

CHARACTER FindString

Returns	CHARACTER

Top

Consultingwerk.SmartComponents.Interfaces.Design.IDesignCommitSource LinkCommitSource

Returns	Consultingwerk.SmartComponents.Interfaces.Design.IDesignCommitSource

Top

Consultingwerk.OERA.INamedQueryParameter NamedQuery

Returns	Consultingwerk.OERA.INamedQueryParameter

Top

CHARACTER NextContext

Returns	CHARACTER

Top

LOGICAL PreferNativeSerialization

Returns	LOGICAL

Top

INTEGER PrefetchOnFindRowWhere

Returns	INTEGER

Top

CHARACTER PrevContext

Returns	CHARACTER

Top

CHARACTER PreviousFetchQueries

Returns	CHARACTER

Top

LOGICAL PromptWhenRetrieveDataInUpdateState

Returns	LOGICAL

Top

CHARACTER QueryString

Returns	CHARACTER

Top

LOGICAL RequestPending

Returns	LOGICAL

Top

LOGICAL RetrieveDataAsync

Returns	LOGICAL

Top

LOGICAL RetrieveDataOnChangeSortOrder

Returns	LOGICAL

Top

LOGICAL RetrieveDataPending

Returns	LOGICAL

Top

Progress.Lang.Object SaveChangesParameter

Returns	Progress.Lang.Object

Top

Consultingwerk.OERA.IServiceAdapter ServiceAdapter

Returns	Consultingwerk.OERA.IServiceAdapter

Top

Consultingwerk.SmartComponents.Interfaces.ISmartCommitSource SmartCommitSource

Returns	Consultingwerk.SmartComponents.Interfaces.ISmartCommitSource

Top

Consultingwerk.SmartComponents.Enum.TransactionStateEnum SmartTransactionState

Returns	Consultingwerk.SmartComponents.Enum.TransactionStateEnum

Top

INTEGER StopAfter

Returns	INTEGER

info@consultingwerk.de http://www.consultingwerk.de 30.03.2026 11:06:16