[This is preliminary documentation and is subject to change.]
An instance of this class is used to determine how Persistate deals
with the results of an OperationExecution.
Declaration Syntax| C# |
public class ExecutionResult
Members| All Members | Constructors | Methods | Properties | Fields | |
| Icon | Member | Description |
|---|---|---|
 | ExecutionResult(ResultAction, String, String, Object, String, Single, DatabaseExceptionHandler) | Create a new ExecutionResult with all parameters supplied.
|
| ExecutionResult(ResultAction, String, Object, String, Single) | Create a new ExecutionResult with all parameters except the DatabaseExceptionHandler supplied.
The default handler is used. |
| ExecutionResult(ResultAction, String) | Create a new ExecutionResult with a particular ResultAction and message, null result object and
status, default DatabaseExceptionHandler, and a
negative percent complete, signifying that application status will be
hidden. |
| ExecutionResult(ResultAction, String, Object) | Create a new ExecutionResult with a particular ResultAction, message and result object, default
DatabaseExceptionHandler, null
status and a negative percent complete, signifying that application status
will be hidden. |
| ExecutionResult(ResultAction, String, Single) | Create a new ExecutionResult with a particular ResultAction, status and percent complete, and
null message and result object, and default DatabaseExceptionHandler. |
| ExecutionResult(ResultAction, String, String, Single) | Create a new ExecutionResult with a particular ResultAction, message, status and percent
complete, and null result object and default DatabaseExceptionHandler. |
| ExecutionResult(ResultAction, String, DatabaseExceptionHandler) |
Create a new ExecutionResult with a particular ResultAction, message, and DatabaseExceptionHandler, null result
object. null status and a negative percent complete. |
| ExecutionResult(Exception) |
Creates an ExecutionResult to return details of an exception condition.
|
  | CommitResult | An ExecutionResult for general use which contains a Commit ResultAction, no messages, null result, null
status, default DatabaseExceptionHandler and a negative percentage
complete. |
 | DatabaseExceptionHandler | Gets the DatabaseExceptionHandler set by the
operation. This is used during the commit phase of the operation execution
to deal with any database errors occurring. |
| DetailMessage | Gets a more detailed message describing the result. This is
always set for exception results and will contain all exception messages
and stack traces. |
| Equals(Object) | (Inherited from Object.) |
| Exception | Gets any exception thrown by the operation.
|
 | Finalize()()()() |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) |
| GetHashCode()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) |
| GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) |
| HardCommitResult | An ExecutionResult for general use which contains a HardCommit
ResultAction, no messages, null result, null
status, default DatabaseExceptionHandler and a negative percentage
complete. |
| MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
| NoActionResult | An ExecutionResult for general use which contains a NoAction ResultAction, no messages, null result, null
status, default DatabaseExceptionHandler and a negative percentage
complete. |
| PercentComplete | Gets the percentage complete value set by the operation.
|
| ReExecuteResult | An ExecutionResult for general use which contains a ReExecute
ResultAction, no messages, null result, null
status, default DatabaseExceptionHandler and a negative percentage
complete. |
| Result | Gets the result object set by the operation. |
| ResultAction | Gets the ResultAction associated
with the ExecutionResult. This is usually set by the operation Execute
method, but can also be set by the Persistate infrastructure if say an
exception occurred. |
| RollbackResult | An ExecutionResult for general use which contains a Rollback ResultAction, no messages, null result, null
status, default DatabaseExceptionHandler and a negative percentage
complete. |
| SimpleMessage | Gets a simple message describing the result. |
| Status | Gets the status message set by the operation. |
| ToString()()()() | (Inherited from Object.) |
RemarksAn ExecutionResult encapsulates a value determining whether there should be a database commit, rollback or no action, along with various optional settings - a popup message to display, a return value from the operation call, a status area message, a status area percent complete value, a handler which will be called if a commit fails.
ExecutionResults are immutable, so you can use the same one repeatedly. Four public static ExecutionResult fields are provided for commit, rollback, re-execute and no action, with all other properties having default values. If you don't supply a DatabaseExceptionHandler, the default handler will be used. This is available from DbaSession.DefaultDatabaseExceptionHandler.
Inheritance Hierarchy| Object | |
 | ExecutionResult |