Class ClearUnitBuyoffMessage

Namespace: Acuit.Pinpoint.Workstation.Messaging

Assembly: Acuit.Pinpoint.Workstation.Abstractions.dll

The message raised by the IMessenger service when the operator clicks a buyoff button for a buyoff that is currently set.

public class ClearUnitBuyoffMessage : ChangeUnitBuyoffMessage, IWorkstationRequestMessage

Inheritance: object

RequestMessage<UnitBuyoff>

WorkstationRequestMessage<UnitBuyoff>

ChangeUnitBuyoffMessage

ClearUnitBuyoffMessage

Implements: IWorkstationRequestMessage

Inherited Members: ChangeUnitBuyoffMessage.BuyoffName

RequestMessage<UnitBuyoff>.Reply(UnitBuyoff)

RequestMessage<UnitBuyoff>.Response

RequestMessage<UnitBuyoff>.HasReceivedResponse

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

By default, Acuit Pinpoint Workstation will handle this message when a unit is at the station by clearing the unit buyoff via ClearBuyoff(string), displaying an error message if the operation fails. If no unit is at the station, Acuit Pinpoint Workstation will ignore this message.

If the buyoff was successfully cleared, the message Response will contain the resulting UnitBuyoff; otherwise, it will contain null.

A plug-in can customize the default behavior by registering a recipient for this message. To suppress the default behavior, the plug-in should use Reply(T) to set the response to the message.

A plug-in can emulate the operator action that this message represents by sending this message.

Constructors

ClearUnitBuyoffMessage(string)

Initializes a new instance of the ClearUnitBuyoffMessage class.

public ClearUnitBuyoffMessage(string buyoffName)

Parameters

buyoffName string: The buyoff name.

Exceptions