Platform SDK Java 8.5 API Reference

com.genesyslab.platform.management.protocol.localcontrolagent.requests
Class RequestUpdateStatus

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.localcontrolagent.requests.RequestUpdateStatus
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestUpdateStatus
extends Message

Requests to change the status (running mode) of application.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestUpdateStatus create()
          Creates instance of RequestUpdateStatus with no parameters set.
static RequestUpdateStatus create(java.lang.String applicationName, java.lang.Integer controlStatus)
          Creates instance of RequestUpdateStatus with required parameters set.
static RequestUpdateStatus create(java.lang.String applicationName, java.lang.Integer controlStatus, java.lang.Integer processId, ApplicationExecutionMode executionMode, java.lang.Integer controlObjectId)
          Creates instance of RequestUpdateStatus with all parameters set.
abstract  java.lang.String getApplicationName()
           
abstract  java.lang.Integer getControlObjectId()
          Attribute description: Object DBID.
abstract  java.lang.Integer getControlStatus()
           
abstract  ApplicationExecutionMode getExecutionMode()
           
abstract  java.lang.Integer getProcessId()
           
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  void setApplicationName(java.lang.String applicationName)
           
abstract  void setControlObjectId(int controlObjectId)
          Attribute description: Object DBID.
abstract  void setControlObjectId(java.lang.Integer controlObjectId)
          Attribute description: Object DBID.
abstract  void setControlStatus(int controlStatus)
           
abstract  void setControlStatus(java.lang.Integer controlStatus)
           
abstract  void setExecutionMode(ApplicationExecutionMode executionMode)
           
abstract  void setProcessId(int processId)
           
abstract  void setProcessId(java.lang.Integer processId)
           
abstract  void setReferenceId(int referenceId)
          Reference identifier of the request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference identifier of 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 RequestUpdateStatus create()
Creates instance of RequestUpdateStatus with no parameters set.

Returns:
instance of RequestUpdateStatus

create

public static RequestUpdateStatus create(java.lang.String applicationName,
                                         java.lang.Integer controlStatus,
                                         java.lang.Integer processId,
                                         ApplicationExecutionMode executionMode,
                                         java.lang.Integer controlObjectId)
Creates instance of RequestUpdateStatus with all parameters set.

Parameters:
applicationName - ApplicationName
controlStatus - ControlStatus
processId - ProcessId
executionMode - ExecutionMode
controlObjectId - ControlObjectId
Returns:
instance of RequestUpdateStatus

create

public static RequestUpdateStatus create(java.lang.String applicationName,
                                         java.lang.Integer controlStatus)
Creates instance of RequestUpdateStatus with required parameters set.

Parameters:
applicationName - ApplicationName
controlStatus - ControlStatus
Returns:
instance of RequestUpdateStatus

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.


getApplicationName

public abstract java.lang.String getApplicationName()

setApplicationName

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

getControlStatus

public abstract java.lang.Integer getControlStatus()

setControlStatus

public abstract void setControlStatus(java.lang.Integer controlStatus)

setControlStatus

public abstract void setControlStatus(int controlStatus)

getProcessId

public abstract java.lang.Integer getProcessId()

setProcessId

public abstract void setProcessId(java.lang.Integer processId)

setProcessId

public abstract void setProcessId(int processId)

getExecutionMode

public abstract ApplicationExecutionMode getExecutionMode()

setExecutionMode

public abstract void setExecutionMode(ApplicationExecutionMode executionMode)

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.


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.