ShelveSelected

<< Click to Display Table of Contents >>

 

ShelveSelected

ShelveSelected(Duration, Reason, [Operator])

Allows shelving the selected Alarms or Events. If there is no selected Alarm or Event in the E3Alarm, this method fails. Users can shelve an Alarm or Event, and in this case a new record is inserted on the Database indicating that shelving, and on the E3Alarm the corresponding row indicates it was shelved. The Duration parameter indicates a period of time, in minutes, in which the Alarms or Events remain shelved. The Reason parameter indicates a reason for shelving. The Operator parameter is an optional String indicating the name of the operator who shelved the Alarm or Event. This value is displayed on E3Alarm's Operator column. If omitted, the current Elipse Water Viewer's user is used or "(No User)", if there is no user logged on. For the shelving itself, the logged-on user must have the Alarm shelving permission.

Was this page useful?