Click or drag to resize

BeforeRequeryArgs Class

The event args for the MapperBeforeRequery event.
Remarks
When DataProvided is set the MapperBeforeRequery event is only fired when there's a cache miss or ForceMapperBeforeRequery is set.
Inheritance Hierarchy

Namespace:  NetQuarry.Data
Assembly:  EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)
Syntax
public class BeforeRequeryArgs : EAPEventArgs

The BeforeRequeryArgs type exposes the following members.

Constructors
  NameDescription
Public methodBeforeRequeryArgs
Constructor.
Top
Properties
  NameDescription
Public propertyBulkContext
Gets/sets the context of the current bulk operation, if any. If this event is part of a bulk operation, this is the context of that bulk operation. If this event is not part of a bulk operation, this context will be null.
(Inherited from EAPEventArgs.)
Public propertyCacheDate
Gets/sets the cache date/time for Data when the mapper has already obtained the operational data from cache. Check DataFromCache to determine if Data was obtained from cache.
Public propertyData
If a DataTable is provided, it will be used to populate the mapper and no mapper database query will be performed. The structure for the DataTable can be obtained from the mapper by calling Exec(MapperExecCmds, Int32, Object) with the RetrieveDataTable command.

Only the mapper's primary data can be provided during the MapperBeforeRequery event. To provide aggregate data, set Data during the MapperExecSQL event for the Aggregate statement type.

Public propertyDirty
Gets/sets whether the Data value has been changed.
Public propertyErrorDeveloperMessage
An optional, developer-specific error message. This will be logged to the Devlog and xot_request_log, but only displayed in user error messages when the user is identified as IsDeveloper.
(Inherited from EAPEventArgs.)
Public propertyCode exampleErrorMessage
Sets the extention's error message for this event.
(Inherited from EAPEventArgs.)
Public propertyErrorOptions
Options used to specify additional characteristics about an exception.
(Inherited from EAPEventArgs.)
Public propertyEvent
Gets/Sets the event that is currently executing.
(Inherited from EAPEventArgs.)
Public propertyHints
Gets/sets hints about the upcoming Requery(RequeryHints) and/or to communicate hints back from the extension to the mapper.
Public propertyResult
Gets/Sets the result to return from the event.
(Inherited from EAPEventArgs.)
Public propertyRowKey
Gets/sets the RowKey associated with the query about to be performed. A null value could indicate either that the query is not specifically a query for a particular record by its RowKey, or that it is unknown whether or not the query is for a particular record by RowKey.
Public propertyTopN
Gets the TOPN setting for the upcoming query -- that is, the maximum number of records requested. If the extension provides data in Data it may choose to ignore this value and provide additional data which may help with the RecordCount determination.
Top
Methods
  NameDescription
Public methodCode exampleCancel
Sets the extention's result code and error message for this event. The result code is set to ExtResultsExtResults.Cancel.
(Inherited from EAPEventArgs.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodCode exampleError(String)
Sets the extention's result code and error message for this event. The result code is set to Error. Use Error(String, String, ExceptionOptions) to include an additional developer message and/or options.
(Inherited from EAPEventArgs.)
Public methodCode exampleError(String, String, ExceptionOptions)
Sets the extention's result code and error message for this event with an optional developer-specific error message and options. The result code is set to Error.
(Inherited from EAPEventArgs.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodEqualValue
Determines if the object value is equal to another object. If the two objects are null, then this returns true. There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways). If the special guid handling is not performed, then the object.Equals method is used.
(Defined by EAPUtil.)
Top
See Also