Platform SDK Java 8.5 API Reference

com.genesyslab.platform.configuration.protocol.confserver.runtime.channel
Class EventProtocolVersion

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.configuration.protocol.confserver.runtime.channel.EventProtocolVersion
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class EventProtocolVersion
extends Message


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventProtocolVersion create()
          Creates instance of EventProtocolVersion with no parameters set.
static EventProtocolVersion create(java.lang.String oldProtocolVersion)
          Creates instance of EventProtocolVersion with required parameters set.
static EventProtocolVersion create(java.lang.String oldProtocolVersion, java.lang.Integer errorCode, java.lang.String securityParams, java.lang.Integer serverEncoding)
          Creates instance of EventProtocolVersion with all parameters set.
abstract  java.lang.Integer getErrorCode()
          Error code.
abstract  java.lang.String getOldProtocolVersion()
          Old Protocol Version
abstract  java.lang.Integer getReferenceId()
          Reference ID to connect response to request.
abstract  java.lang.String getSecurityParams()
          None
abstract  java.lang.Integer getServerEncoding()
          Represents internal server encoding.
abstract  void setErrorCode(int errorCode)
          Error code.
abstract  void setErrorCode(java.lang.Integer errorCode)
          Error code.
abstract  void setOldProtocolVersion(java.lang.String oldProtocolVersion)
          Old Protocol Version
abstract  void setReferenceId(int referenceId)
          Reference ID to connect response to request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference ID to connect response to request.
abstract  void setSecurityParams(java.lang.String securityParams)
          None
abstract  void setServerEncoding(int serverEncoding)
          Represents internal server encoding.
abstract  void setServerEncoding(java.lang.Integer serverEncoding)
          Represents internal server encoding.
 
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 EventProtocolVersion create()
Creates instance of EventProtocolVersion with no parameters set.

Returns:
instance of EventProtocolVersion

create

public static EventProtocolVersion create(java.lang.String oldProtocolVersion,
                                          java.lang.Integer errorCode,
                                          java.lang.String securityParams,
                                          java.lang.Integer serverEncoding)
Creates instance of EventProtocolVersion with all parameters set.

Parameters:
oldProtocolVersion - Old Protocol Version
errorCode - Error code.
securityParams - None
serverEncoding - Represents internal server encoding. Supported values are: 0 - system default, 1 - UTF-8.
Returns:
instance of EventProtocolVersion

create

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

Parameters:
oldProtocolVersion - Old Protocol Version
Returns:
instance of EventProtocolVersion

getReferenceId

public abstract java.lang.Integer getReferenceId()
Reference ID to connect response to request. If set to 0, it means that ReferenceID should be assigned by ReferenceBuilder.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
Reference ID to connect response to request. If set to 0, it means that ReferenceID should be assigned by ReferenceBuilder.


setReferenceId

public abstract void setReferenceId(int referenceId)
Reference ID to connect response to request. If set to 0, it means that ReferenceID should be assigned by ReferenceBuilder.


getOldProtocolVersion

public abstract java.lang.String getOldProtocolVersion()
Old Protocol Version

Returns:
property value

setOldProtocolVersion

public abstract void setOldProtocolVersion(java.lang.String oldProtocolVersion)
Old Protocol Version

Parameters:
oldProtocolVersion - new value of the property

getErrorCode

public abstract java.lang.Integer getErrorCode()
Error code.

Returns:
property value

setErrorCode

public abstract void setErrorCode(java.lang.Integer errorCode)
Error code.

Parameters:
errorCode - new value of the property

setErrorCode

public abstract void setErrorCode(int errorCode)
Error code.

Parameters:
errorCode - new value of the property

getSecurityParams

public abstract java.lang.String getSecurityParams()
None

Returns:
property value

setSecurityParams

public abstract void setSecurityParams(java.lang.String securityParams)
None

Parameters:
securityParams - new value of the property

getServerEncoding

public abstract java.lang.Integer getServerEncoding()
Represents internal server encoding. Supported values are: 0 - system default, 1 - UTF-8.

Returns:
property value

setServerEncoding

public abstract void setServerEncoding(java.lang.Integer serverEncoding)
Represents internal server encoding. Supported values are: 0 - system default, 1 - UTF-8.

Parameters:
serverEncoding - new value of the property

setServerEncoding

public abstract void setServerEncoding(int serverEncoding)
Represents internal server encoding. Supported values are: 0 - system default, 1 - UTF-8.

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