Platform SDK Java 8.5 API Reference

com.genesyslab.platform.configuration.protocol.confserver.events
Class EventError

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.configuration.protocol.confserver.events.EventError
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class EventError
extends Message


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventError create()
          Creates instance of EventError with no parameters set.
static EventError create(java.lang.Integer errorCode, java.lang.String description)
          Creates instance of EventError with required parameters set.
static EventError create(java.lang.Integer errorCode, java.lang.String description, java.lang.Integer externalAuthentication)
          Creates instance of EventError with all parameters set.
abstract  java.lang.String getDescription()
          Used for description of an error if type of event is error
abstract  java.lang.Integer getErrorCode()
          Error code.
abstract  java.lang.Integer getExternalAuthentication()
          For the external systems authentication
abstract  java.lang.Integer getReferenceId()
          Reference ID to connect response to request.
abstract  void setDescription(java.lang.String description)
          Used for description of an error if type of event is error
abstract  void setErrorCode(int errorCode)
          Error code.
abstract  void setErrorCode(java.lang.Integer errorCode)
          Error code.
abstract  void setExternalAuthentication(int externalAuthentication)
          For the external systems authentication
abstract  void setExternalAuthentication(java.lang.Integer externalAuthentication)
          For the external systems authentication
abstract  void setReferenceId(int referenceId)
          Reference ID to connect response to request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference ID to connect response to 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 EventError create()
Creates instance of EventError with no parameters set.

Returns:
instance of EventError

create

public static EventError create(java.lang.Integer errorCode,
                                java.lang.String description,
                                java.lang.Integer externalAuthentication)
Creates instance of EventError with all parameters set.

Parameters:
errorCode - Error code.
description - Used for description of an error if type of event is error
externalAuthentication - For the external systems authentication
Returns:
instance of EventError

create

public static EventError create(java.lang.Integer errorCode,
                                java.lang.String description)
Creates instance of EventError with required parameters set.

Parameters:
errorCode - Error code.
description - Used for description of an error if type of event is error
Returns:
instance of EventError

getReferenceId

public abstract java.lang.Integer getReferenceId()
Reference ID to connect response to request. If set to 0, it means that ReferenceID should be assigned by ReferenceBuilder.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
Reference ID to connect response to request. If set to 0, it means that ReferenceID should be assigned by ReferenceBuilder.


setReferenceId

public abstract void setReferenceId(int referenceId)
Reference ID to connect response to request. If set to 0, it means that ReferenceID should be assigned by ReferenceBuilder.


getErrorCode

public abstract java.lang.Integer getErrorCode()
Error code.

Returns:
property value

setErrorCode

public abstract void setErrorCode(java.lang.Integer errorCode)
Error code.

Parameters:
errorCode - new value of the property

setErrorCode

public abstract void setErrorCode(int errorCode)
Error code.

Parameters:
errorCode - new value of the property

getDescription

public abstract java.lang.String getDescription()
Used for description of an error if type of event is error

Returns:
property value

setDescription

public abstract void setDescription(java.lang.String description)
Used for description of an error if type of event is error

Parameters:
description - new value of the property

getExternalAuthentication

public abstract java.lang.Integer getExternalAuthentication()
For the external systems authentication

Returns:
property value

setExternalAuthentication

public abstract void setExternalAuthentication(java.lang.Integer externalAuthentication)
For the external systems authentication

Parameters:
externalAuthentication - new value of the property

setExternalAuthentication

public abstract void setExternalAuthentication(int externalAuthentication)
For the external systems authentication

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