Configuration Platform SDK 7.6 API Reference

com.genesyslab.platform.configuration.protocol.confserver.events
Class EventObjectCreated

java.lang.Object
  extended bycom.genesyslab.platform.commons.protocol.DataObject
      extended bycom.genesyslab.platform.commons.protocol.Message
          extended bycom.genesyslab.platform.configuration.protocol.confserver.events.EventObjectCreated
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class EventObjectCreated
extends Message


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventObjectCreated create()
          Creates instance of EventObjectCreated with no parameters set.
static EventObjectCreated create(java.lang.Integer objectType, org.w3c.dom.Document confObject)
          Creates instance of EventObjectCreated with required parameters set.
static EventObjectCreated create(java.lang.Integer objectType, org.w3c.dom.Document confObject, java.lang.Integer unsolisitedEventNumber, java.lang.Integer folderDbid, java.lang.Integer time, java.lang.Boolean isHistoryLog)
          Creates instance of EventObjectCreated with all parameters set.
abstract  org.w3c.dom.Document getConfObject()
          XmlDocumentV7 representation of cfglib object(s)
abstract  java.lang.Integer getFolderDbid()
          Folder identifier
abstract  java.lang.Boolean getIsHistoryLog()
          History log flag, when true means that event belongs to history log updates
abstract  java.lang.Integer getObjectType()
          Type of configuration object as defined in ConfServerObject enum
abstract  java.lang.Integer getReferenceId()
          Reference id to connect responce to request.
abstract  java.lang.Integer getTime()
          Time when the event was issued by Configuration Server
abstract  java.lang.Integer getUnsolisitedEventNumber()
          Unsolicited notification event's number
abstract  void setConfObject(org.w3c.dom.Document confObject)
          XmlDocumentV7 representation of cfglib object(s)
abstract  void setFolderDbid(int folderDbid)
          Folder identifier
abstract  void setFolderDbid(java.lang.Integer folderDbid)
          Folder identifier
abstract  void setIsHistoryLog(java.lang.Boolean isHistoryLog)
          History log flag, when true means that event belongs to history log updates
abstract  void setObjectType(int objectType)
          Type of configuration object as defined in ConfServerObject enum
abstract  void setObjectType(java.lang.Integer objectType)
          Type of configuration object as defined in ConfServerObject enum
abstract  void setReferenceId(int referenceId)
          Reference id to connect responce to request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference id to connect responce to request.
abstract  void setTime(int time)
          Time when the event was issued by Configuration Server
abstract  void setTime(java.lang.Integer time)
          Time when the event was issued by Configuration Server
abstract  void setUnsolisitedEventNumber(int unsolisitedEventNumber)
          Unsolicited notification event's number
abstract  void setUnsolisitedEventNumber(java.lang.Integer unsolisitedEventNumber)
          Unsolicited notification event's number
 
Methods inherited from class com.genesyslab.platform.commons.protocol.Message
cloneMessage, getEndpoint, getMessageAttribute, getProtocolDescription, getProtocolId, messageId, messageName
 
Methods inherited from class com.genesyslab.platform.commons.protocol.DataObject
equals, hashCode, toString, toString
 
Methods inherited from class java.lang.Object
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 EventObjectCreated create()
Creates instance of EventObjectCreated with no parameters set.

Returns:
instance of EventObjectCreated

create

public static EventObjectCreated create(java.lang.Integer objectType,
                                        org.w3c.dom.Document confObject,
                                        java.lang.Integer unsolisitedEventNumber,
                                        java.lang.Integer folderDbid,
                                        java.lang.Integer time,
                                        java.lang.Boolean isHistoryLog)
Creates instance of EventObjectCreated with all parameters set.

Parameters:
objectType - Type of configuration object as defined in ConfServerObject enum
confObject - XmlDocumentV7 representation of cfglib object(s)
unsolisitedEventNumber - Unsolicited notification event's number
folderDbid - Folder identifier
time - Time when the event was issued by Configuration Server
isHistoryLog - History log flag, when true means that event belongs to history log updates
Returns:
instance of EventObjectCreated

create

public static EventObjectCreated create(java.lang.Integer objectType,
                                        org.w3c.dom.Document confObject)
Creates instance of EventObjectCreated with required parameters set.

Parameters:
objectType - Type of configuration object as defined in ConfServerObject enum
confObject - XmlDocumentV7 representation of cfglib object(s)
Returns:
instance of EventObjectCreated

getReferenceId

public abstract java.lang.Integer getReferenceId()
Reference id to connect responce to request. If set to 0, it means that ReferenceID should be assighed by ReferenceBuilder.

Returns:
property value

setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
Reference id to connect responce to request. If set to 0, it means that ReferenceID should be assighed by ReferenceBuilder.

Parameters:
referenceId - new value of the property

setReferenceId

public abstract void setReferenceId(int referenceId)
Reference id to connect responce to request. If set to 0, it means that ReferenceID should be assighed by ReferenceBuilder.

Parameters:
referenceId - new value of the property

getObjectType

public abstract java.lang.Integer getObjectType()
Type of configuration object as defined in ConfServerObject enum

Returns:
property value

setObjectType

public abstract void setObjectType(java.lang.Integer objectType)
Type of configuration object as defined in ConfServerObject enum

Parameters:
objectType - new value of the property

setObjectType

public abstract void setObjectType(int objectType)
Type of configuration object as defined in ConfServerObject enum

Parameters:
objectType - new value of the property

getConfObject

public abstract org.w3c.dom.Document getConfObject()
XmlDocumentV7 representation of cfglib object(s)

Returns:
property value

setConfObject

public abstract void setConfObject(org.w3c.dom.Document confObject)
XmlDocumentV7 representation of cfglib object(s)

Parameters:
confObject - new value of the property

getUnsolisitedEventNumber

public abstract java.lang.Integer getUnsolisitedEventNumber()
Unsolicited notification event's number

Returns:
property value

setUnsolisitedEventNumber

public abstract void setUnsolisitedEventNumber(java.lang.Integer unsolisitedEventNumber)
Unsolicited notification event's number

Parameters:
unsolisitedEventNumber - new value of the property

setUnsolisitedEventNumber

public abstract void setUnsolisitedEventNumber(int unsolisitedEventNumber)
Unsolicited notification event's number

Parameters:
unsolisitedEventNumber - new value of the property

getFolderDbid

public abstract java.lang.Integer getFolderDbid()
Folder identifier

Returns:
property value

setFolderDbid

public abstract void setFolderDbid(java.lang.Integer folderDbid)
Folder identifier

Parameters:
folderDbid - new value of the property

setFolderDbid

public abstract void setFolderDbid(int folderDbid)
Folder identifier

Parameters:
folderDbid - new value of the property

getTime

public abstract java.lang.Integer getTime()
Time when the event was issued by Configuration Server

Returns:
property value

setTime

public abstract void setTime(java.lang.Integer time)
Time when the event was issued by Configuration Server

Parameters:
time - new value of the property

setTime

public abstract void setTime(int time)
Time when the event was issued by Configuration Server

Parameters:
time - new value of the property

getIsHistoryLog

public abstract java.lang.Boolean getIsHistoryLog()
History log flag, when true means that event belongs to history log updates

Returns:
property value

setIsHistoryLog

public abstract void setIsHistoryLog(java.lang.Boolean isHistoryLog)
History log flag, when true means that event belongs to history log updates

Parameters:
isHistoryLog - new value of the property

Configuration Platform SDK 7.6 API Reference

Send comments on this topic.
Copyright © 2006–2008 Genesys Telecommunication Laboratories, Inc. All rights reserved.