Platform SDK Java 8.5 API Reference

com.genesyslab.platform.webmedia.protocol.flexchat
Class Description

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.flexchat.Description
All Implemented Interfaces:
ProtocolDescriptionSupport

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

Event notification or error description structure.


Constructor Summary
Description()
           
 
Method Summary
static Description create()
          Creates instance of Description with no parameters set.
static Description create(java.lang.String errorId)
          Creates instance of Description with required parameters set.
static Description create(java.lang.String errorId, java.lang.String text)
          Creates instance of Description with all parameters set.
abstract  java.lang.String getErrorId()
          The error ID returned in an EventError event.
abstract  java.lang.String getText()
          If NoticeType is not equal to None, then this property contains the notification text.
abstract  void setErrorId(java.lang.String errorId)
          The error ID returned in an EventError event.
abstract  void setText(java.lang.String text)
          If NoticeType is not equal to None, then this property contains the notification 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

Description

public Description()
Method Detail

create

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

Returns:
instance of Description

create

public static Description create(java.lang.String errorId,
                                 java.lang.String text)
Creates instance of Description with all parameters set.

Parameters:
errorId - ErrorId
text - Text
Returns:
instance of Description

create

public static Description create(java.lang.String errorId)
Creates instance of Description with required parameters set.

Parameters:
errorId - ErrorId
Returns:
instance of Description

getErrorId

public abstract java.lang.String getErrorId()
The error ID returned in an EventError event.


setErrorId

public abstract void setErrorId(java.lang.String errorId)
The error ID returned in an EventError event.


getText

public abstract java.lang.String getText()
If NoticeType is not equal to None, then this property contains the notification text. Otherwise, it holds the message text.


setText

public abstract void setText(java.lang.String text)
If NoticeType is not equal to None, then this property contains the notification text. Otherwise, it holds the message text.


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.