Platform SDK Java 8.5 API Reference

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

public abstract class RequestRegisterClient
extends Message

Registers the client application. RequestRegisterClient is automatically sent on SolutionControlServerProtocol.Open().


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.Integer controlObjectId, java.lang.Integer connectCode)
          Creates instance of RequestRegisterClient with required parameters set.
static RequestRegisterClient create(java.lang.Integer controlObjectId, java.lang.Integer connectCode, ControlObjectType controlObjectType, java.lang.String userName, java.lang.String applicationName)
          Creates instance of RequestRegisterClient with all parameters set.
abstract  java.lang.String getApplicationName()
          .
abstract  java.lang.Integer getConnectCode()
          Connection code.
abstract  java.lang.Integer getControlObjectId()
          Attribute description: Object DBID.
abstract  ControlObjectType getControlObjectType()
          Object type.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  java.lang.String getUserName()
          .
abstract  void setApplicationName(java.lang.String applicationName)
          .
abstract  void setConnectCode(int connectCode)
          Connection code.
abstract  void setConnectCode(java.lang.Integer connectCode)
          Connection code.
abstract  void setControlObjectId(int controlObjectId)
          Attribute description: Object DBID.
abstract  void setControlObjectId(java.lang.Integer controlObjectId)
          Attribute description: Object DBID.
abstract  void setControlObjectType(ControlObjectType controlObjectType)
          Object type.
abstract  void setReferenceId(int referenceId)
          Reference identifier of the request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference identifier of the request.
abstract  void setUserName(java.lang.String userName)
          .
 
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.Integer controlObjectId,
                                           java.lang.Integer connectCode,
                                           ControlObjectType controlObjectType,
                                           java.lang.String userName,
                                           java.lang.String applicationName)
Creates instance of RequestRegisterClient with all parameters set.

Parameters:
controlObjectId - Application ControlObjectId.
connectCode - Connection code.
controlObjectType - Object type.
userName - .
applicationName - .
Returns:
instance of RequestRegisterClient

create

public static RequestRegisterClient create(java.lang.Integer controlObjectId,
                                           java.lang.Integer connectCode)
Creates instance of RequestRegisterClient with required parameters set.

Parameters:
controlObjectId - Application ControlObjectId.
connectCode - Connection code.
Returns:
instance of RequestRegisterClient

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.


getControlObjectId

public abstract java.lang.Integer getControlObjectId()
Attribute description: Object DBID.


setControlObjectId

public abstract void setControlObjectId(java.lang.Integer controlObjectId)
Attribute description: Object DBID.


setControlObjectId

public abstract void setControlObjectId(int controlObjectId)
Attribute description: Object DBID.


getConnectCode

public abstract java.lang.Integer getConnectCode()
Connection code.

Returns:
property value

setConnectCode

public abstract void setConnectCode(java.lang.Integer connectCode)
Connection code.

Parameters:
connectCode - new value of the property

setConnectCode

public abstract void setConnectCode(int connectCode)
Connection code.

Parameters:
connectCode - new value of the property

getControlObjectType

public abstract ControlObjectType getControlObjectType()
Object type.

Returns:
property value

setControlObjectType

public abstract void setControlObjectType(ControlObjectType controlObjectType)
Object type.

Parameters:
controlObjectType - new value of the property

getUserName

public abstract java.lang.String getUserName()
.

Returns:
property value

setUserName

public abstract void setUserName(java.lang.String userName)
.

Parameters:
userName - new value of the property

getApplicationName

public abstract java.lang.String getApplicationName()
.

Returns:
property value

setApplicationName

public abstract void setApplicationName(java.lang.String applicationName)
.

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