Platform SDK Java 8.5 API Reference

com.genesyslab.platform.webmedia.protocol.basicchat
Class Reason

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.runtime.CompoundValue
          extended by com.genesyslab.platform.webmedia.protocol.basicchat.Reason
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class Reason
extends com.genesyslab.platform.commons.protocol.runtime.CompoundValue


Constructor Summary
Reason()
           
 
Method Summary
static Reason create()
          Creates instance of Reason with no parameters set.
static Reason create(java.lang.Integer code)
          Creates instance of Reason with required parameters set.
static Reason create(java.lang.Integer code, java.lang.String text)
          Creates instance of Reason with all parameters set.
abstract  java.lang.Integer getCode()
          The error code in an error Description.
abstract  java.lang.String getText()
          Any arbitrary text.
abstract  void setCode(int code)
          The error code in an error Description.
abstract  void setCode(java.lang.Integer code)
          The error code in an error Description.
abstract  void setText(java.lang.String text)
          Any arbitrary text.
 
Methods inherited from class com.genesyslab.platform.commons.protocol.runtime.CompoundValue
getProtocolDescription
 
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
 

Constructor Detail

Reason

public Reason()
Method Detail

create

public static Reason create()
Creates instance of Reason with no parameters set.

Returns:
instance of Reason

create

public static Reason create(java.lang.Integer code,
                            java.lang.String text)
Creates instance of Reason with all parameters set.

Parameters:
code - Code
text - Text
Returns:
instance of Reason

create

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

Parameters:
code - Code
Returns:
instance of Reason

getCode

public abstract java.lang.Integer getCode()
The error code in an error Description.


setCode

public abstract void setCode(java.lang.Integer code)
The error code in an error Description.


setCode

public abstract void setCode(int code)
The error code in an error Description.


getText

public abstract java.lang.String getText()
Any arbitrary text. For example, when used with the NoticeText class this could contain a URL if the NoticeType is set to PushURL or be empty for TypingStarted notifications.


setText

public abstract void setText(java.lang.String text)
Any arbitrary text. For example, when used with the NoticeText class this could contain a URL if the NoticeType is set to PushURL or be empty for TypingStarted notifications.


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.