|
Configuration Platform SDK 7.6 API Reference | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.commons.protocol.DataObject
com.genesyslab.platform.commons.protocol.Message
com.genesyslab.platform.configuration.protocol.confserver.events.EventObjectsRead
Returns information about objects in the Genesys Configuration Layer.
The information you asked for is returned by invoking the getConfObject
method of the EventObjectsRead
message. This method returns an
org.w3c.dom.Document
representation of the object, as shown here:
EventObjectsRead objectsRead =
(EventObjectsRead) theMessage;
System.out.println(theMessage.messageName());
System.out.println("There are "
+ objectsRead.getObjectTotalCount() + " objects of this type.");
Document resultDocument =
(Document) objectsRead.getConfObject();
It is important to note that Configuration Server may send more than one
of these messages in response to your request, depending on how much data
needs to be returned. Your application must be ready to handle all of these
messages.
Your application also needs to process the EventObjectsSent
message that Configuration Server will send to indicate that it has finished
providing the data you requested.
Field Summary | |
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
static EventObjectsRead |
create()
Creates instance of EventObjectsRead with no parameters set. |
static EventObjectsRead |
create(java.lang.Integer objectType,
java.lang.Integer objectCount,
org.w3c.dom.Document confObject,
java.lang.Integer objectTotalCount)
Creates instance of EventObjectsRead. |
static EventObjectsRead |
create(java.lang.Integer objectType,
java.lang.Integer objectCount,
org.w3c.dom.Document confObject,
java.lang.Integer objectTotalCount,
java.lang.String[] objectPaths,
long[] folderDbids,
java.lang.String format)
Creates instance of EventObjectsRead. |
static EventObjectsRead |
create(java.lang.Integer objectType,
java.lang.Integer objectCount,
org.w3c.dom.Document confObject,
java.lang.Integer objectTotalCount,
java.lang.String[] objectPaths,
java.lang.String objectPath,
long[] folderDbids,
java.lang.String format)
Deprecated. The constructor is deprecated. |
abstract org.w3c.dom.Document |
getConfObject()
XmlDocumentV7 representation of cfglib object(s) |
abstract long[] |
getFolderDbids()
Array of unique identifiers of objects' folders |
abstract java.lang.String |
getFormat()
None |
abstract java.lang.Integer |
getObjectCount()
Number of objects matching requested criteria |
abstract java.lang.String |
getObjectPath()
Deprecated. The property is deprecated, please use 'ObjectPaths' property instead. |
abstract java.lang.String[] |
getObjectPaths()
Configuration objects' path array |
abstract java.lang.Integer |
getObjectTotalCount()
Total number of objects matching requested criteria |
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 void |
setConfObject(org.w3c.dom.Document confObject)
XmlDocumentV7 representation of cfglib object(s) |
abstract void |
setFolderDbids(long[] folderDbids)
Array of unique identifiers of objects' folders |
abstract void |
setFormat(java.lang.String format)
None |
abstract void |
setObjectCount(int objectCount)
Number of objects matching requested criteria |
abstract void |
setObjectCount(java.lang.Integer objectCount)
Number of objects matching requested criteria |
abstract void |
setObjectPath(java.lang.String objectPath)
Deprecated. The property is deprecated, please use 'ObjectPaths' property instead. |
abstract void |
setObjectPaths(java.lang.String[] objectPaths)
Configuration objects' path array |
abstract void |
setObjectTotalCount(int objectTotalCount)
Total number of objects matching requested criteria |
abstract void |
setObjectTotalCount(java.lang.Integer objectTotalCount)
Total number of objects matching requested criteria |
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. |
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 |
public static final int ID
public static final java.lang.String NAME
Method Detail |
public static EventObjectsRead create()
public static EventObjectsRead create(java.lang.Integer objectType, java.lang.Integer objectCount, org.w3c.dom.Document confObject, java.lang.Integer objectTotalCount, java.lang.String[] objectPaths, java.lang.String objectPath, long[] folderDbids, java.lang.String format)
objectType
- Type of configuration object as defined in ConfServerObject enumobjectCount
- Number of objects matching requested criteriaconfObject
- XmlDocumentV7 representation of cfglib object(s)objectTotalCount
- Total number of objects matching requested criteriaobjectPaths
- Configuration objects' path arrayobjectPath
- Configuration objects' path stringfolderDbids
- Array of unique identifiers of objects' foldersformat
- None
public static EventObjectsRead create(java.lang.Integer objectType, java.lang.Integer objectCount, org.w3c.dom.Document confObject, java.lang.Integer objectTotalCount)
objectType
- Type of configuration object as defined in ConfServerObject enumobjectCount
- Number of objects matching requested criteriaconfObject
- XmlDocumentV7 representation of cfglib object(s)objectTotalCount
- Total number of objects matching requested criteria
public static EventObjectsRead create(java.lang.Integer objectType, java.lang.Integer objectCount, org.w3c.dom.Document confObject, java.lang.Integer objectTotalCount, java.lang.String[] objectPaths, long[] folderDbids, java.lang.String format)
objectType
- Type of configuration object as defined in ConfServerObject enumobjectCount
- Number of objects matching requested criteriaconfObject
- XmlDocumentV7 representation of cfglib object(s)objectTotalCount
- Total number of objects matching requested criteriaobjectPaths
- Configuration objects' path arrayfolderDbids
- Array of unique identifiers of objects' foldersformat
- None
public abstract java.lang.Integer getReferenceId()
public abstract void setReferenceId(java.lang.Integer referenceId)
referenceId
- new value of the propertypublic abstract void setReferenceId(int referenceId)
referenceId
- new value of the propertypublic abstract java.lang.Integer getObjectType()
public abstract void setObjectType(java.lang.Integer objectType)
objectType
- new value of the propertypublic abstract void setObjectType(int objectType)
objectType
- new value of the propertypublic abstract java.lang.Integer getObjectCount()
public abstract void setObjectCount(java.lang.Integer objectCount)
objectCount
- new value of the propertypublic abstract void setObjectCount(int objectCount)
objectCount
- new value of the propertypublic abstract org.w3c.dom.Document getConfObject()
public abstract void setConfObject(org.w3c.dom.Document confObject)
confObject
- new value of the propertypublic abstract java.lang.Integer getObjectTotalCount()
public abstract void setObjectTotalCount(java.lang.Integer objectTotalCount)
objectTotalCount
- new value of the propertypublic abstract void setObjectTotalCount(int objectTotalCount)
objectTotalCount
- new value of the propertypublic abstract java.lang.String[] getObjectPaths()
public abstract void setObjectPaths(java.lang.String[] objectPaths)
objectPaths
- new value of the propertypublic abstract java.lang.String getObjectPath()
public abstract void setObjectPath(java.lang.String objectPath)
objectPath
- new value of the propertypublic abstract long[] getFolderDbids()
public abstract void setFolderDbids(long[] folderDbids)
folderDbids
- new value of the propertypublic abstract java.lang.String getFormat()
public abstract void setFormat(java.lang.String format)
format
- new value of the property
|
Configuration Platform SDK 7.6 API Reference | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |