Platform SDK Java 8.5 API Reference

com.genesyslab.platform.management.protocol.solutioncontrolserver.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.management.protocol.solutioncontrolserver.events.EventError
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class EventError
extends Message

Error event.


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 client, Errors errorCode, ControlObjectType controlObjectType, java.lang.Integer controlObjectId, java.lang.String description)
          Creates instance of EventError with all parameters set.
abstract  java.lang.Integer getClient()
          no desc.
abstract  java.lang.Integer getControlObjectId()
          Attribute description: Object DBID.
abstract  ControlObjectType getControlObjectType()
          Object type.
abstract  java.lang.String getDescription()
          Description
abstract  Errors getErrorCode()
          Error code.
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 setControlObjectType(ControlObjectType controlObjectType)
          Object type.
abstract  void setDescription(java.lang.String description)
          Description
abstract  void setErrorCode(Errors errorCode)
          Error code.
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 EventError create()
Creates instance of EventError with no parameters set.

Returns:
instance of EventError

create

public static EventError create(java.lang.Integer client,
                                Errors errorCode,
                                ControlObjectType controlObjectType,
                                java.lang.Integer controlObjectId,
                                java.lang.String description)
Creates instance of EventError with all parameters set.

Parameters:
client - no desc.
errorCode - Error code.
controlObjectType - Object type.
controlObjectId - Application ControlObjectId.
description - Description
Returns:
instance of EventError

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

getErrorCode

public abstract Errors getErrorCode()
Error code.

Returns:
property value

setErrorCode

public abstract void setErrorCode(Errors errorCode)
Error code.

Parameters:
errorCode - new value of the property

getControlObjectType

public abstract ControlObjectType getControlObjectType()
Object type.

Returns:
property value

setControlObjectType

public abstract void setControlObjectType(ControlObjectType controlObjectType)
Object type.

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


getDescription

public abstract java.lang.String getDescription()
Description

Returns:
property value

setDescription

public abstract void setDescription(java.lang.String description)
Description

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