Platform SDK Java 8.5 API Reference

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

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.RequestReadObjects2
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestReadObjects2
extends Message

Requests complete information about the object(s) specified by XPath expression.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestReadObjects2 create()
          Creates instance of RequestReadObjects2 with no parameters set.
static RequestReadObjects2 create(java.lang.Integer objectType, java.lang.String xPathExpression)
          Creates instance of RequestReadObjects2 with all parameters set.
abstract  java.lang.Integer getObjectType()
          Type of configuration object as defined in ConfServerObject enum
abstract  java.lang.Integer getReferenceId()
          Reference ID to connect response to request.
abstract  java.lang.String getXPathExpression()
          XPath Expression
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 response to request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference ID to connect response to request.
abstract  void setXPathExpression(java.lang.String xPathExpression)
          XPath Expression
 
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 RequestReadObjects2 create()
Creates instance of RequestReadObjects2 with no parameters set.

Returns:
instance of RequestReadObjects2

create

public static RequestReadObjects2 create(java.lang.Integer objectType,
                                         java.lang.String xPathExpression)
Creates instance of RequestReadObjects2 with all parameters set.

Parameters:
objectType - Type of configuration object as defined in ConfServerObject enum
xPathExpression - XPath Expression
Returns:
instance of RequestReadObjects2

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

getXPathExpression

public abstract java.lang.String getXPathExpression()
XPath Expression

Returns:
property value

setXPathExpression

public abstract void setXPathExpression(java.lang.String xPathExpression)
XPath Expression

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