|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.commons.protocol.DataObject
com.genesyslab.platform.commons.protocol.Message
com.genesyslab.platform.management.protocol.solutioncontrolserver.events.EventAlarmInfo
public abstract class EventAlarmInfo
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 |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static 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)
controlObjectType
- Object type.controlObjectId
- Application ControlObjectId.alarmConditionId
- no desc.activationTime
- no desc.expirationTimeout
- no desc.description
- DescriptionalarmDescription
- 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.
public abstract ControlObjectType getControlObjectType()
public abstract void setControlObjectType(ControlObjectType controlObjectType)
controlObjectType
- new value of the propertypublic abstract java.lang.Integer getControlObjectId()
public abstract void setControlObjectId(java.lang.Integer controlObjectId)
public abstract void setControlObjectId(int controlObjectId)
public abstract java.lang.Integer getAlarmConditionId()
public abstract void setAlarmConditionId(java.lang.Integer alarmConditionId)
alarmConditionId
- new value of the propertypublic abstract void setAlarmConditionId(int alarmConditionId)
alarmConditionId
- new value of the propertypublic abstract java.lang.Integer getActivationTime()
public abstract void setActivationTime(java.lang.Integer activationTime)
activationTime
- new value of the propertypublic abstract void setActivationTime(int activationTime)
activationTime
- new value of the propertypublic abstract java.lang.Integer getExpirationTimeout()
public abstract void setExpirationTimeout(java.lang.Integer expirationTimeout)
expirationTimeout
- new value of the propertypublic abstract void setExpirationTimeout(int expirationTimeout)
expirationTimeout
- new value of the propertypublic abstract java.lang.String getDescription()
public abstract void setDescription(java.lang.String description)
description
- new value of the propertypublic abstract AlarmDescription getAlarmDescription()
public abstract void setAlarmDescription(AlarmDescription alarmDescription)
alarmDescription
- new value of the propertypublic abstract java.lang.Integer getControlStatus()
public abstract void setControlStatus(java.lang.Integer controlStatus)
controlStatus
- new value of the propertypublic abstract void setControlStatus(int controlStatus)
controlStatus
- new value of the property
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |