The Confirm Method is used to confirm an Event Notifications for a Condition instance state where ConfirmedState is False. Normally, the NodeId of the object instance is passed as the ObjectId to the Call Service. However, some Servers do not expose Condition instances in the AddressSpace. Therefore, Servers shall allow Clients to call the Confirm Method by specifying ConditionId as the ObjectId. The Method cannot be called with an ObjectId of the AcknowledgeableConditionType Node.
Signature
Confirm(
[in] ByteString EventId
[in] LocalizedTextComment
);
The parameters are defined in Table 39
Table 39 – Confirm Method parameters
|
Argument |
Description |
|
EventId |
EventId identifying a particular Event Notification. Only Event Notifications where the Id property of the ConfirmedState is False can be confirmed. |
|
Comment |
A localized text to be applied to the Conditions. |
Method result codes in Table 40 (defined in Call Service)
Table 40 – Confirm result codes
|
Result Code |
Description |
|
Bad_ConditionBranchAlreadyConfirmed |
See Table 137 for the description of this result code. |
|
Bad_MethodInvalid |
The method id does not refer to a method for the specified object or ConditionId. See 10000-4 for the general description of this result code. |
|
Bad_EventIdUnknown |
See Table 137 for the description of this result code. |
|
Bad_NodeIdInvalid |
Used to indicate that the specified ObjectId is not valid or that the Method was called on the AcknowledgeableConditionType Node. See 10000-4 for the general description of this result code. |
Comments
A Server is responsible to ensure that each Event has a unique EventId. This allows Clients to identify and confirm a particular Event Notification.
The EventId identifies a specific Event Notification where a state to be confirmed was reported. A Comment can be provided which will be applied to the state identified with the EventId. If the comment field is NULL (both locale and text are empty) it will be ignored and any existing comments will remain unchanged. If the comment is to be reset, an empty text with a locale shall be provided.
A valid EventId will result in an Event Notification where ConfirmedState/Id is set to True and the Comment Property contains the text of the optional comment argument. If a previous state is confirmed, the BranchId and all Condition values of this branch will be reported. A Client can confirm only events that have a ConfirmedState/Id set to False. The logic for setting ConfirmedState/Id to False is Server specific and may even be event or condition specific.
Table 41 specifies the AddressSpace representation for the Confirm Method.
Table 41 – Confirm Method AddressSpace definition
|
Attribute |
Value |
||||
|
BrowseName |
Confirm |
||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
HasProperty |
InputArguments |
Argument[] |
PropertyType |
Mandatory |
|
|
AlwaysGeneratesEvent |
ObjectType |
AuditConditionConfirmEventType |
Defined in 5.10.7
|
||
|
ConformanceUnits |
|||||
|
A & C Confirm |
|||||
If Auditing is supported, this Method shall generate an Event of AuditConditionConfirmEventType for all invocations of the Method.