Platform SDK Java 8.5 API Reference

com.genesyslab.platform.reporting.protocol.statserver.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.reporting.protocol.statserver.runtime.channel.RequestRegisterClient
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestRegisterClient
extends Message


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 protocolName, java.lang.Integer libraryInternalVersion, java.lang.String clientName, java.lang.Integer clientId)
          Creates instance of RequestRegisterClient with required parameters set.
static RequestRegisterClient create(java.lang.String protocolName, java.lang.Integer libraryInternalVersion, java.lang.String clientName, java.lang.Integer clientId, KeyValueCollection clientCapabilities)
          Creates instance of RequestRegisterClient with all parameters set.
abstract  KeyValueCollection getClientCapabilities()
           
abstract  java.lang.Integer getClientId()
           
abstract  java.lang.String getClientName()
          The name of the client application.
abstract  java.lang.Integer getLibraryInternalVersion()
           
abstract  java.lang.String getProtocolName()
          Name of the current protocol.
abstract  void setClientCapabilities(KeyValueCollection clientCapabilities)
           
abstract  void setClientId(int clientId)
           
abstract  void setClientId(java.lang.Integer clientId)
           
abstract  void setClientName(java.lang.String clientName)
          The name of the client application.
abstract  void setLibraryInternalVersion(int libraryInternalVersion)
           
abstract  void setLibraryInternalVersion(java.lang.Integer libraryInternalVersion)
           
abstract  void setProtocolName(java.lang.String protocolName)
          Name of the current protocol.
 
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 protocolName,
                                           java.lang.Integer libraryInternalVersion,
                                           java.lang.String clientName,
                                           java.lang.Integer clientId,
                                           KeyValueCollection clientCapabilities)
Creates instance of RequestRegisterClient with all parameters set.

Parameters:
protocolName - ProtocolName
libraryInternalVersion - LibraryInternalVersion
clientName - ClientName
clientId - ClientId
clientCapabilities - ClientCapabilities
Returns:
instance of RequestRegisterClient

create

public static RequestRegisterClient create(java.lang.String protocolName,
                                           java.lang.Integer libraryInternalVersion,
                                           java.lang.String clientName,
                                           java.lang.Integer clientId)
Creates instance of RequestRegisterClient with required parameters set.

Parameters:
protocolName - ProtocolName
libraryInternalVersion - LibraryInternalVersion
clientName - ClientName
clientId - ClientId
Returns:
instance of RequestRegisterClient

getProtocolName

public abstract java.lang.String getProtocolName()
Name of the current protocol.


setProtocolName

public abstract void setProtocolName(java.lang.String protocolName)
Name of the current protocol.


getLibraryInternalVersion

public abstract java.lang.Integer getLibraryInternalVersion()

setLibraryInternalVersion

public abstract void setLibraryInternalVersion(java.lang.Integer libraryInternalVersion)

setLibraryInternalVersion

public abstract void setLibraryInternalVersion(int libraryInternalVersion)

getClientName

public abstract java.lang.String getClientName()
The name of the client application.


setClientName

public abstract void setClientName(java.lang.String clientName)
The name of the client application.


getClientId

public abstract java.lang.Integer getClientId()

setClientId

public abstract void setClientId(java.lang.Integer clientId)

setClientId

public abstract void setClientId(int clientId)

getClientCapabilities

public abstract KeyValueCollection getClientCapabilities()

setClientCapabilities

public abstract void setClientCapabilities(KeyValueCollection clientCapabilities)

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.