Platform SDK Java 8.5 API Reference

com.genesyslab.platform.outbound.protocol.outboundserver.runtime.channel
Class RequestRegisterClient

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.outbound.protocol.outboundserver.runtime.channel.RequestRegisterClient
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestRegisterClient
extends Message

Sent to OCS to register the client upon connection. For internal use only.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestRegisterClient create()
          Creates instance of RequestRegisterClient with no parameters set.
static RequestRegisterClient create(java.lang.String libraryProtocol)
          Creates instance of RequestRegisterClient with required parameters set.
static RequestRegisterClient create(java.lang.String libraryProtocol, KeyValueCollection requestProperties)
          Creates instance of RequestRegisterClient with all parameters set.
abstract  java.lang.String getLibraryProtocol()
          Specifies the library protocol (internal use)
abstract  java.lang.Integer getReferenceId()
          The reference id by which requests are associated with corresponding events.
abstract  KeyValueCollection getRequestProperties()
          A KeyValue list of additional information passed to the request
abstract  void setLibraryProtocol(java.lang.String libraryProtocol)
          Specifies the library protocol (internal use)
abstract  void setReferenceId(int referenceId)
          The reference id by which requests are associated with corresponding events.
abstract  void setReferenceId(java.lang.Integer referenceId)
          The reference id by which requests are associated with corresponding events.
abstract  void setRequestProperties(KeyValueCollection requestProperties)
          A KeyValue list of additional information passed to the 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 RequestRegisterClient create()
Creates instance of RequestRegisterClient with no parameters set.

Returns:
instance of RequestRegisterClient

create

public static RequestRegisterClient create(java.lang.String libraryProtocol,
                                           KeyValueCollection requestProperties)
Creates instance of RequestRegisterClient with all parameters set.

Parameters:
libraryProtocol - Specifies the library protocol (internal use)
requestProperties - A KeyValue list of additional information passed to the request
Returns:
instance of RequestRegisterClient

create

public static RequestRegisterClient create(java.lang.String libraryProtocol)
Creates instance of RequestRegisterClient with required parameters set.

Parameters:
libraryProtocol - Specifies the library protocol (internal use)
Returns:
instance of RequestRegisterClient

getReferenceId

public abstract java.lang.Integer getReferenceId()
The reference id by which requests are associated with corresponding events.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
The reference id by which requests are associated with corresponding events.


setReferenceId

public abstract void setReferenceId(int referenceId)
The reference id by which requests are associated with corresponding events.


getLibraryProtocol

public abstract java.lang.String getLibraryProtocol()
Specifies the library protocol (internal use)

Returns:
property value

setLibraryProtocol

public abstract void setLibraryProtocol(java.lang.String libraryProtocol)
Specifies the library protocol (internal use)

Parameters:
libraryProtocol - new value of the property

getRequestProperties

public abstract KeyValueCollection getRequestProperties()
A KeyValue list of additional information passed to the request

Returns:
property value

setRequestProperties

public abstract void setRequestProperties(KeyValueCollection requestProperties)
A KeyValue list of additional information passed to the request

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