Configuration Platform SDK 7.6 API Reference

com.genesyslab.platform.configuration.protocol.confserver.requests.objects
Class RequestUpdateObject

java.lang.Object
  extended bycom.genesyslab.platform.commons.protocol.DataObject
      extended bycom.genesyslab.platform.commons.protocol.Message
          extended bycom.genesyslab.platform.configuration.protocol.confserver.requests.objects.RequestUpdateObject
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestUpdateObject
extends Message

Sets new property values specified by ConfObject (delta object) for the object specified by ObjectType and delta_object.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestUpdateObject create()
          Creates instance of RequestUpdateObject with no parameters set.
static RequestUpdateObject create(java.lang.Integer objectType, org.w3c.dom.Document confObject)
          Creates instance of RequestUpdateObject with required parameters set.
static RequestUpdateObject create(java.lang.Integer objectType, org.w3c.dom.Document confObject, KeyValueCollection parameters)
          Creates instance of RequestUpdateObject with all parameters set.
abstract  org.w3c.dom.Document getConfObject()
          XmlDocumentV7 representation of cfglib object(s)
abstract  java.lang.Integer getObjectType()
          Type of configuration object as defined in ConfServerObject enum
abstract  KeyValueCollection getParameters()
          TKVList containing additional parameters (if needed)
abstract  java.lang.Integer getReferenceId()
          Reference id to connect responce to request.
abstract  void setConfObject(org.w3c.dom.Document confObject)
          XmlDocumentV7 representation of cfglib object(s)
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 setParameters(KeyValueCollection parameters)
          TKVList containing additional parameters (if needed)
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.
 
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 RequestUpdateObject create()
Creates instance of RequestUpdateObject with no parameters set.

Returns:
instance of RequestUpdateObject

create

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

Parameters:
objectType - Type of configuration object as defined in ConfServerObject enum
confObject - XmlDocumentV7 representation of cfglib object(s)
parameters - TKVList containing additional parameters (if needed)
Returns:
instance of RequestUpdateObject

create

public static RequestUpdateObject create(java.lang.Integer objectType,
                                         org.w3c.dom.Document confObject)
Creates instance of RequestUpdateObject 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 RequestUpdateObject

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

getParameters

public abstract KeyValueCollection getParameters()
TKVList containing additional parameters (if needed)

Returns:
property value

setParameters

public abstract void setParameters(KeyValueCollection parameters)
TKVList containing additional parameters (if needed)

Parameters:
parameters - 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.