Platform SDK Java 8.5 API Reference

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

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.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(ConfObjectDelta objectDelta)
          Creates instance of RequestUpdateObject.
static RequestUpdateObject create(ConfObjectDelta objectDelta, KeyValueCollection parameters)
          Creates instance of RequestUpdateObject.
static RequestUpdateObject create(java.lang.Integer objectType, org.w3c.dom.Document confObject)
          Deprecated. Use new configuration server structures instead of DOM.
static RequestUpdateObject create(java.lang.Integer objectType, org.w3c.dom.Document confObject, KeyValueCollection parameters)
          Deprecated. Use new configuration server structures instead of DOM.
abstract  org.w3c.dom.Document getConfObject()
          Deprecated. Use new configuration server structures instead of DOM.
abstract  ConfObjectDelta getObjectDelta()
          ConfObjectDelta representation of a configuration server delta object
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 response to request.
abstract  void setConfObject(org.w3c.dom.Document confObject)
          Deprecated. Use new configuration server structures instead of DOM.
abstract  void setObjectDelta(ConfObjectDelta objectDelta)
          ConfObjectDelta representation of a configuration server delta object
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 response to request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference ID to connect response to request.
 
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 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)
Deprecated. Use new configuration server structures instead of DOM.

Creates instance of RequestUpdateObject.

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

create

public static RequestUpdateObject create(java.lang.Integer objectType,
                                         org.w3c.dom.Document confObject,
                                         KeyValueCollection parameters)
Deprecated. Use new configuration server structures instead of DOM.

Creates instance of RequestUpdateObject.

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(ConfObjectDelta objectDelta)
Creates instance of RequestUpdateObject.

Parameters:
objectDelta - ConfObjectDelta representation of a configuration server delta object
Returns:
instance of RequestUpdateObject

create

public static RequestUpdateObject create(ConfObjectDelta objectDelta,
                                         KeyValueCollection parameters)
Creates instance of RequestUpdateObject.

Parameters:
objectDelta - ConfObjectDelta representation of a configuration server delta object
parameters - TKVList containing additional parameters (if needed)
Returns:
instance of RequestUpdateObject

getReferenceId

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


setReferenceId

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


setReferenceId

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


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

@Deprecated
public abstract org.w3c.dom.Document getConfObject()
Deprecated. Use new configuration server structures instead of DOM.

XmlDocumentV7 representation of cfglib object(s)

Returns:
property value

setConfObject

@Deprecated
public abstract void setConfObject(org.w3c.dom.Document confObject)
Deprecated. Use new configuration server structures instead of DOM.

XmlDocumentV7 representation of cfglib object(s)

Parameters:
confObject - new value of the property

getObjectDelta

public abstract ConfObjectDelta getObjectDelta()
ConfObjectDelta representation of a configuration server delta object

Returns:
property value

setObjectDelta

public abstract void setObjectDelta(ConfObjectDelta objectDelta)
ConfObjectDelta representation of a configuration server delta object

Parameters:
objectDelta - 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

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.