CompensableActivity Class

.NET Framework (current version)
 

An activity that supports compensation of its child activities.

Namespace:   System.Activities.Statements
Assembly:  System.Activities (in System.Activities.dll)

System.Object
  System.Activities.Activity
    System.Activities.ActivityWithResult
      System.Activities.Activity<TResult>
        System.Activities.NativeActivity<TResult>
          System.Activities.Statements.CompensableActivity

[ContentPropertyAttribute("Body")]
public sealed class CompensableActivity : NativeActivity<CompensationToken>

NameDescription
System_CAPS_pubmethodCompensableActivity()

Initializes a new instance of the CompensableActivity class.

NameDescription
System_CAPS_pubpropertyBody

Gets or sets the activity that is scheduled when the CompensableActivity executes.

System_CAPS_protpropertyCacheId

Gets the identifier of the cache that is unique within the scope of the workflow definition.(Inherited from Activity.)

System_CAPS_pubpropertyCancellationHandler

Gets or sets the activity that is scheduled when the activity is canceled.

System_CAPS_pubpropertyCompensationHandler

Gets or sets the activity that is scheduled when compensation is performed on the CompensableActivity.

System_CAPS_pubpropertyConfirmationHandler

Gets or sets the activity that is scheduled when confirmation is performed for this CompensableActivity.

System_CAPS_pubpropertyDisplayName

Gets or sets an optional friendly name that is used for debugging, validation, exception handling, and tracking.(Inherited from Activity.)

System_CAPS_pubpropertyId

Gets an identifier that is unique in the scope of the workflow definition.(Inherited from Activity.)

System_CAPS_protpropertyImplementationVersion

Gets or sets the implementation version of the activity.(Inherited from NativeActivity<TResult>.)

System_CAPS_pubpropertyResult

Gets or sets the result argument for the Activity<TResult>.(Inherited from Activity<TResult>.)

System_CAPS_pubpropertyResultType

When implemented in a derived class, gets the type of an activity OutArgument.(Inherited from ActivityWithResult.)

System_CAPS_pubpropertyVariables

Gets the collection of T:System.WorkflowModel.Variable objects for this CompensableActivity.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodShouldSerializeDisplayName()

Indicates whether the DisplayName property should be serialized.(Inherited from Activity.)

System_CAPS_pubmethodToString()

Returns a String that contains the Id and DisplayName of the Activity.(Inherited from Activity.)

CompensableActivity allows a developer to specify a Body activity that defines a long-running task that performs their core business logic. It also allows the developer to optionally specify a compensation and confirmation activity to schedule appropriate business logic in the event of errors or successful completion of the Body. Compensation and confirmation of a CompensableActivity is invoked by using the CompensationToken returned by the CompensableActivity. CompensationToken is an opaque, typed object returned as the P:System.Activities.WorkflowElement`1.Result argument after successful completion of a CompensableActivity activity’s Body. This CompensationToken is used by the Confirm and Compensate activities to explicitly invoke confirmation and compensation of a CompensableActivity. CompensableActivity can be composed in a nested hierarchical fashion in the workflow. For more information, seeCompensation Programming Model.

.NET Framework
Available since 4.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: