using System;

namespace ZB.MOM.WW.MxGateway.Worker.MxAccess;

/// <summary>
///     Optional ack-only seam over AVEVA's modern managed alarm client
///     (<c>aaAlarmManagedClient.AlarmClient</c>). When supplied to an
///     <see cref="AlarmDispatcher"/>, GUID-keyed acknowledges route here
///     instead of the wnwrap COM consumer's <c>AlarmAckByGUID</c> (which is
///     <c>E_NOTIMPL</c> on current builds) — carrying full operator identity
///     (domain + full name) that the wnwrap 6-arg <c>AlarmAckByName</c> drops.
///     The production implementation is <see cref="AaManagedAlarmAckConsumer"/>.
/// </summary>
public interface IManagedAlarmAckClient : IDisposable
{
    /// <summary>
    ///     Run the client's Initialize → Register → Subscribe lifecycle against
    ///     the same subscription expression the read consumer uses
    ///     (<c>\\&lt;node&gt;\Galaxy!&lt;area&gt;</c>). Must be called once,
    ///     on the worker STA, before <see cref="AcknowledgeByGuid"/>.
    /// </summary>
    /// <param name="subscription">The subscription expression.</param>
    void Subscribe(string subscription);

    /// <summary>
    ///     Acknowledge a single alarm by GUID with full operator identity.
    ///     Returns AVEVA's native status (0 = success; 0 means accepted, not
    ///     necessarily applied — verify the alarm's acked state / Historian row).
    /// </summary>
    /// <param name="alarmGuid">The alarm GUID.</param>
    /// <param name="comment">The acknowledgment comment.</param>
    /// <param name="operatorName">The operator name.</param>
    /// <param name="operatorNode">The operator node.</param>
    /// <param name="operatorDomain">The operator domain.</param>
    /// <param name="operatorFullName">The operator full name.</param>
    /// <returns>The AVEVA-native status code.</returns>
    int AcknowledgeByGuid(
        Guid alarmGuid,
        string comment,
        string operatorName,
        string operatorNode,
        string operatorDomain,
        string operatorFullName);
}