Platform SDK Java 8.5 API Reference

com.genesyslab.platform.management.protocol.solutioncontrolserver.requests
Class RequestRetrieveEnvironment

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.management.protocol.solutioncontrolserver.requests.RequestRetrieveEnvironment
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestRetrieveEnvironment
extends Message

Retrieves info about environment/configuration objects. Filters could be applied: applications, hosts, solutions.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestRetrieveEnvironment create()
          Creates instance of RequestRetrieveEnvironment with no parameters set.
static RequestRetrieveEnvironment create(KeyValueCollection requestData)
          Creates instance of RequestRetrieveEnvironment with all parameters set.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  KeyValueCollection getRequestData()
          This is a 'fake' attribute generated (parsed) from attributeId=13 (XkvData).
abstract  void setReferenceId(int referenceId)
          Reference identifier of the request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference identifier of the request.
abstract  void setRequestData(KeyValueCollection requestData)
          This is a 'fake' attribute generated (parsed) from attributeId=13 (XkvData).
 
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 RequestRetrieveEnvironment create()
Creates instance of RequestRetrieveEnvironment with no parameters set.

Returns:
instance of RequestRetrieveEnvironment

create

public static RequestRetrieveEnvironment create(KeyValueCollection requestData)
Creates instance of RequestRetrieveEnvironment with all parameters set.

Parameters:
requestData - This is a 'fake' attribute generated (parsed) from attributeId=13 (XkvData). So for subscription (see AttributeSubscriptionList class for details) user should use id=13 instead of 1001.
Returns:
instance of RequestRetrieveEnvironment

getReferenceId

public abstract java.lang.Integer getReferenceId()
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


setReferenceId

public abstract void setReferenceId(int referenceId)
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


getRequestData

public abstract KeyValueCollection getRequestData()
This is a 'fake' attribute generated (parsed) from attributeId=13 (XkvData). So for subscription (see AttributeSubscriptionList class for details) user should use id=13 instead of 1001.

Returns:
property value

setRequestData

public abstract void setRequestData(KeyValueCollection requestData)
This is a 'fake' attribute generated (parsed) from attributeId=13 (XkvData). So for subscription (see AttributeSubscriptionList class for details) user should use id=13 instead of 1001.

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