Platform SDK Java 8.5 API Reference

com.genesyslab.platform.management.protocol.localcontrolagent.events
Class EventSuspendApplication

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.events.EventSuspendApplication
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class EventSuspendApplication
extends Message

Is returned on the RequestStopApplicationGracefully message. An application can react to this event by setting Suspending status (to show scs that it needs time for finishing processing messages) and then Suspended (to show that application is ready to be stopped). Or application (if it doesn't support this functionality) will be stopped after some timeout.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventSuspendApplication create()
          Creates instance of EventSuspendApplication with no parameters set.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
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 EventSuspendApplication create()
Creates instance of EventSuspendApplication with no parameters set.

Returns:
instance of EventSuspendApplication

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.


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.