Platform SDK Java 8.5 API Reference

com.genesyslab.platform.management.protocol.solutioncontrolserver.requests.applications
Class RequestStartApplication

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.requests.applications.RequestStartApplication
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestStartApplication
extends Message

If you submit RequestSubscribe before RequestStartApplication, then you receive either EventInfo or EventError as a response. If the application is already running, then EventError is returned. If you submit RequestStartApplication without first subscribing to application events, then you should use Send method because Solution Control Server does not send any response unless there is an active subscription.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestStartApplication create()
          Creates instance of RequestStartApplication with no parameters set.
static RequestStartApplication create(java.lang.Integer controlObjectId)
          Creates instance of RequestStartApplication with required parameters set.
static RequestStartApplication create(java.lang.Integer client, java.lang.Integer controlObjectId, java.lang.Integer objectStatus)
          Creates instance of RequestStartApplication with all parameters set.
abstract  java.lang.Integer getClient()
          no desc.
abstract  java.lang.Integer getControlObjectId()
          Attribute description: Object DBID.
abstract  java.lang.Integer getObjectStatus()
          Object status.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  void setClient(int client)
          no desc.
abstract  void setClient(java.lang.Integer client)
          no desc.
abstract  void setControlObjectId(int controlObjectId)
          Attribute description: Object DBID.
abstract  void setControlObjectId(java.lang.Integer controlObjectId)
          Attribute description: Object DBID.
abstract  void setObjectStatus(int objectStatus)
          Object status.
abstract  void setObjectStatus(java.lang.Integer objectStatus)
          Object status.
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 RequestStartApplication create()
Creates instance of RequestStartApplication with no parameters set.

Returns:
instance of RequestStartApplication

create

public static RequestStartApplication create(java.lang.Integer client,
                                             java.lang.Integer controlObjectId,
                                             java.lang.Integer objectStatus)
Creates instance of RequestStartApplication with all parameters set.

Parameters:
client - no desc.
controlObjectId - Application ControlObjectId.
objectStatus - Object status.
Returns:
instance of RequestStartApplication

create

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

Parameters:
controlObjectId - Application ControlObjectId.
Returns:
instance of RequestStartApplication

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.


getClient

public abstract java.lang.Integer getClient()
no desc.

Returns:
property value

setClient

public abstract void setClient(java.lang.Integer client)
no desc.

Parameters:
client - new value of the property

setClient

public abstract void setClient(int client)
no desc.

Parameters:
client - new value of the property

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.


getObjectStatus

public abstract java.lang.Integer getObjectStatus()
Object status.

Returns:
property value

setObjectStatus

public abstract void setObjectStatus(java.lang.Integer objectStatus)
Object status.

Parameters:
objectStatus - new value of the property

setObjectStatus

public abstract void setObjectStatus(int objectStatus)
Object status.

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