5.8.17.7 OneShotShelve2 Method

The OneShotShelve2 Method

Signature

	OneShotShelve2( 
		[in] LocalizedText	Comment
		);
The parameters are defined in Table 89.
Table 89 – OneShotShelve2 Method parameters
Argument Description
CommentA localized text that shall be applied to the Conditions.

If the Comment argument is NULL (both locale and text are empty) it shall be ignored and any existing comments will remain unchanged. To reset the comment, an empty text with a locale shall be provided.

Method Result Codes are defined in Table 90 (status code field is defined in Call Service)

Table 90 – OneShotShelve2 result codes
Result Code Description
Bad_ConditionAlreadyShelved

See Table 137 for the description of this result code.

The Alarm is already in OneShotShelved state.

Bad_InvalidArgumentThe Comment string provided exceeds the allowed length for the comment or is invalid in some other manner.

Table 91 specifies the AddressSpace representation for the OneShotShelve2 Method.

Table 91 – OneShotShelve2 Method AddressSpace definition
Attribute Value
BrowseNameOneShotShelve2
References NodeClass BrowseName DataType TypeDefinition ModellingRule
HasProperty Variable InputArgumentsArgument[] PropertyTypeMandatory
AlwaysGeneratesEventObjectTypeAuditConditionShelvingEventTypeDefined in 5.10.7
ConformanceUnits
A & C Shelving2

If Auditing is supported, this Method shall generate an Event of AuditConditionShelvingEventType for all invocations of the Method.