Platform SDK Java 8.5 API Reference

com.genesyslab.platform.management.protocol.solutioncontrolserver.events
Class EventAlarmInfo

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.management.protocol.solutioncontrolserver.events.EventAlarmInfo
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class EventAlarmInfo
extends Message

Event is returned when alarm is fired or on RequestGetActiveAlarms with alarm's information.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventAlarmInfo create()
          Creates instance of EventAlarmInfo with no parameters set.
static EventAlarmInfo create(ControlObjectType controlObjectType, java.lang.Integer controlObjectId, java.lang.Integer alarmConditionId, java.lang.Integer activationTime, java.lang.Integer expirationTimeout, java.lang.String description, AlarmDescription alarmDescription, java.lang.Integer controlStatus)
          Creates instance of EventAlarmInfo with all parameters set.
abstract  java.lang.Integer getActivationTime()
          no desc.
abstract  java.lang.Integer getAlarmConditionId()
          no desc.
abstract  AlarmDescription getAlarmDescription()
          This is a 'fake' attribute generated (parsed) from attributeId=13 (XkvData).
abstract  java.lang.Integer getControlObjectId()
          Attribute description: Object DBID.
abstract  ControlObjectType getControlObjectType()
          Object type.
abstract  java.lang.Integer getControlStatus()
          Status.
abstract  java.lang.String getDescription()
          Description
abstract  java.lang.Integer getExpirationTimeout()
          no desc.
abstract  void setActivationTime(int activationTime)
          no desc.
abstract  void setActivationTime(java.lang.Integer activationTime)
          no desc.
abstract  void setAlarmConditionId(int alarmConditionId)
          no desc.
abstract  void setAlarmConditionId(java.lang.Integer alarmConditionId)
          no desc.
abstract  void setAlarmDescription(AlarmDescription alarmDescription)
          This is a 'fake' attribute generated (parsed) from attributeId=13 (XkvData).
abstract  void setControlObjectId(int controlObjectId)
          Attribute description: Object DBID.
abstract  void setControlObjectId(java.lang.Integer controlObjectId)
          Attribute description: Object DBID.
abstract  void setControlObjectType(ControlObjectType controlObjectType)
          Object type.
abstract  void setControlStatus(int controlStatus)
          Status.
abstract  void setControlStatus(java.lang.Integer controlStatus)
          Status.
abstract  void setDescription(java.lang.String description)
          Description
abstract  void setExpirationTimeout(int expirationTimeout)
          no desc.
abstract  void setExpirationTimeout(java.lang.Integer expirationTimeout)
          no desc.
 
Methods inherited from class com.genesyslab.platform.commons.protocol.Message
cloneMessage, getEndpoint, getMessageAttribute, getProtocolDescription, getProtocolId, messageId, messageName, setProtocolDescription
 
Methods inherited from class com.genesyslab.platform.commons.protocol.DataObject
equals, hashCode, toString, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ID

public static final int ID
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
See Also:
Constant Field Values
Method Detail

create

public static EventAlarmInfo create()
Creates instance of EventAlarmInfo with no parameters set.

Returns:
instance of EventAlarmInfo

create

public static EventAlarmInfo create(ControlObjectType controlObjectType,
                                    java.lang.Integer controlObjectId,
                                    java.lang.Integer alarmConditionId,
                                    java.lang.Integer activationTime,
                                    java.lang.Integer expirationTimeout,
                                    java.lang.String description,
                                    AlarmDescription alarmDescription,
                                    java.lang.Integer controlStatus)
Creates instance of EventAlarmInfo with all parameters set.

Parameters:
controlObjectType - Object type.
controlObjectId - Application ControlObjectId.
alarmConditionId - no desc.
activationTime - no desc.
expirationTimeout - no desc.
description - Description
alarmDescription - This is a 'fake' attribute generated (parsed) from attributeId=13 (XkvData). So for subscription (see AttributeSubscriptionList class for details) user should use id=13 instead of 1000.
controlStatus - Status.
Returns:
instance of EventAlarmInfo

getControlObjectType

public abstract ControlObjectType getControlObjectType()
Object type.

Returns:
property value

setControlObjectType

public abstract void setControlObjectType(ControlObjectType controlObjectType)
Object type.

Parameters:
controlObjectType - new value of the property

getControlObjectId

public abstract java.lang.Integer getControlObjectId()
Attribute description: Object DBID.


setControlObjectId

public abstract void setControlObjectId(java.lang.Integer controlObjectId)
Attribute description: Object DBID.


setControlObjectId

public abstract void setControlObjectId(int controlObjectId)
Attribute description: Object DBID.


getAlarmConditionId

public abstract java.lang.Integer getAlarmConditionId()
no desc.

Returns:
property value

setAlarmConditionId

public abstract void setAlarmConditionId(java.lang.Integer alarmConditionId)
no desc.

Parameters:
alarmConditionId - new value of the property

setAlarmConditionId

public abstract void setAlarmConditionId(int alarmConditionId)
no desc.

Parameters:
alarmConditionId - new value of the property

getActivationTime

public abstract java.lang.Integer getActivationTime()
no desc.

Returns:
property value

setActivationTime

public abstract void setActivationTime(java.lang.Integer activationTime)
no desc.

Parameters:
activationTime - new value of the property

setActivationTime

public abstract void setActivationTime(int activationTime)
no desc.

Parameters:
activationTime - new value of the property

getExpirationTimeout

public abstract java.lang.Integer getExpirationTimeout()
no desc.

Returns:
property value

setExpirationTimeout

public abstract void setExpirationTimeout(java.lang.Integer expirationTimeout)
no desc.

Parameters:
expirationTimeout - new value of the property

setExpirationTimeout

public abstract void setExpirationTimeout(int expirationTimeout)
no desc.

Parameters:
expirationTimeout - new value of the property

getDescription

public abstract java.lang.String getDescription()
Description

Returns:
property value

setDescription

public abstract void setDescription(java.lang.String description)
Description

Parameters:
description - new value of the property

getAlarmDescription

public abstract AlarmDescription getAlarmDescription()
This is a 'fake' attribute generated (parsed) from attributeId=13 (XkvData). So for subscription (see AttributeSubscriptionList class for details) user should use id=13 instead of 1000.

Returns:
property value

setAlarmDescription

public abstract void setAlarmDescription(AlarmDescription alarmDescription)
This is a 'fake' attribute generated (parsed) from attributeId=13 (XkvData). So for subscription (see AttributeSubscriptionList class for details) user should use id=13 instead of 1000.

Parameters:
alarmDescription - new value of the property

getControlStatus

public abstract java.lang.Integer getControlStatus()
Status.

Returns:
property value

setControlStatus

public abstract void setControlStatus(java.lang.Integer controlStatus)
Status.

Parameters:
controlStatus - new value of the property

setControlStatus

public abstract void setControlStatus(int controlStatus)
Status.

Parameters:
controlStatus - new value of the property

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.