Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com
Class CfgXPathBasedQuery<TT extends ICfgObject>

java.lang.Object
  extended by com.genesyslab.platform.applicationblocks.com.CfgQuery<TT>
      extended by com.genesyslab.platform.applicationblocks.com.CfgXPathBasedQuery<TT>
All Implemented Interfaces:
ICfgQuery<TT>, ICfgQueryObjectClass<TT>

public class CfgXPathBasedQuery<TT extends ICfgObject>
extends CfgQuery<TT>
implements ICfgQueryObjectClass<TT>

This class represents a very special query type for configuration server objects read request.

Disclaimer: It is used for internal undocumented XPath requests support RequestReadObjects2.
It must be used very carefully taking into account fact that this request is not officially supported by configuration server.

Other important note is that Platform SDK is not able to properly validate such request parameters.
So, if given XPath expression is invalid or is inconsistent with the object type parameter, it may lead to unexpected results like exception in data parsing logic or invalid objects.


Constructor Summary
CfgXPathBasedQuery()
          Creates a new uninitialized instance of query.
CfgXPathBasedQuery(IConfService service)
          Deprecated. Use constructor without configuration service parameter.
CfgXPathBasedQuery(IConfService service, int objType, java.lang.String xpath)
          Deprecated. Use constructor without configuration service parameter.
CfgXPathBasedQuery(int objType, java.lang.String xpath)
          Creates a new instance of query.
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 CfgObjectType getCfgObjectType()
          Gets configuration server object type.
 int getObjectType()
          Gets configuration server object type id.
 java.lang.Class<TT> getQueryObjectClass()
           
 java.lang.String getXPath()
          Gets configuration server XPath query expression.
 int hashCode()
           
 void setObjectType(int objType)
          Sets configuration server object type parameter value for the query.
 void setXPath(java.lang.String xpath)
          Sets configuration server XPath query expression.
 java.lang.String toString()
           
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgQuery
beginExecute, endExecute, execute, execute, executeSingleResult, executeSingleResult
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CfgXPathBasedQuery

public CfgXPathBasedQuery()
Creates a new uninitialized instance of query.


CfgXPathBasedQuery

public CfgXPathBasedQuery(int objType,
                          java.lang.String xpath)
Creates a new instance of query.

Parameters:
objType - configuration server object type.
xpath - configuration server specific XPath query expression.
See Also:
setObjectType(int), setXPath(java.lang.String)

CfgXPathBasedQuery

@Deprecated
public CfgXPathBasedQuery(IConfService service)
Deprecated. Use constructor without configuration service parameter.

Creates a new instance of query.

Parameters:
service - reference to IConfService to be used for query execution.

CfgXPathBasedQuery

@Deprecated
public CfgXPathBasedQuery(IConfService service,
                                     int objType,
                                     java.lang.String xpath)
Deprecated. Use constructor without configuration service parameter.

Creates a new instance of query.

Parameters:
service - reference to IConfService to be used for query execution.
objType - configuration server object type.
xpath - configuration server specific XPath query expression.
See Also:
setObjectType(int), setXPath(java.lang.String)
Method Detail

getQueryObjectClass

public java.lang.Class<TT> getQueryObjectClass()
Specified by:
getQueryObjectClass in interface ICfgQueryObjectClass<TT extends ICfgObject>

setObjectType

public void setObjectType(int objType)
Sets configuration server object type parameter value for the query.

Note: This parameter is required for server response proper handling by Platform SDK. And it must be consistent with given XPath expression (setXPath(java.lang.String)).
Invalid or inconsistent values of the query parameters may lead to unexpected results like exception in data parsing logic or invalid objects.

Parameters:
objType - CfgObjectType ordinal value.

getObjectType

public int getObjectType()
Gets configuration server object type id.

Returns:
CfgObjectType ordinal value.

getCfgObjectType

public CfgObjectType getCfgObjectType()
Gets configuration server object type.

Returns:
CfgObjectType value.

setXPath

public void setXPath(java.lang.String xpath)
Sets configuration server XPath query expression.

Note: This parameter is required. And it must be consistent with given object type parameter (setObjectType(int)).
Invalid or inconsistent values of the query parameters may lead to unexpected results like exception in data parsing logic or invalid objects.

Parameters:
xpath - configuration server specific XPath query expression.

getXPath

public java.lang.String getXPath()
Gets configuration server XPath query expression.

Returns:
configuration server specific XPath query expression.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

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.