Class RemovePreassembly
- Namespace
- Acuit.Pinpoint.Workflows.Workstation.Activities
- Assembly
- Acuit.Pinpoint.Workflows.Workstation.dll
An activity that removes a preassembly from the unit at the station, causing a new preassembly to be created containing the removed components and other associated history.
public class RemovePreassembly : Activity<RemovePreassemblyStatus>, IActivity
- Inheritance
-
RemovePreassembly
- Implements
- Inherited Members
Remarks
The result value will be the result of RemovePreassemblyAsync(string).
This will throw a a business logic exception if the preassembly cannot be removed.
This activity requires the IUnitAtStationService service (automatically provided by Acuit Pinpoint Workstation).
Properties
ComponentTypeName
Gets or sets the component type name. This is required.
public ValueSource<string> ComponentTypeName { get; set; }
Property Value
Methods
OnExecuteAsync(ActivityContext, CancellationToken)
Derived classes must implement this to perform the activity.
protected override Task<RemovePreassemblyStatus> OnExecuteAsync(ActivityContext context, CancellationToken cancellationToken)
Parameters
context
ActivityContextThe activity context.
cancellationToken
CancellationTokenThe cancellation token used to request canceling the activity.
Returns
- Task<RemovePreassemblyStatus>
A task that represents the asynchronous operation. The value of its Result property contains the result.
Exceptions
- ArgumentNullException
context
is null.- InvalidOperationException
A service required by the activity is not available, or a required activity property value is not set.
- Exception
An error occurred while performing the activity.
ToString()
Returns a string that represents the current object.
public override string ToString()
Returns
- string
A string that represents the current object.
Remarks
This is expected to produce a string suitable for labeling this activity in a workflow diagram. It should be as specific as possible, but while keeping it very short. In general, it should be the short name of the class (as that is how it would typically be defined in the workflow XAML), optionally followed by other property values of interest in a diagram. The default implementation returns the short name of the class.