Configuration Platform SDK 7.6 API Reference

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

java.lang.Object
  extended bycom.genesyslab.platform.commons.protocol.DataObject
      extended bycom.genesyslab.platform.commons.protocol.Message
          extended bycom.genesyslab.platform.configuration.protocol.confserver.events.EventAuthenticated
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class EventAuthenticated
extends Message


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventAuthenticated create()
          Creates instance of EventAuthenticated with no parameters set.
static EventAuthenticated create(java.lang.String description)
          Creates instance of EventAuthenticated 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 getReferenceId()
          Reference id to connect responce to request.
abstract  void setDescription(java.lang.String description)
          Used for description of an error if type of event is error
abstract  void setReferenceId(int referenceId)
          Reference id to connect responce to request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference id to connect responce to request.
 
Methods inherited from class com.genesyslab.platform.commons.protocol.Message
cloneMessage, getEndpoint, getMessageAttribute, getProtocolDescription, getProtocolId, messageId, messageName
 
Methods inherited from class com.genesyslab.platform.commons.protocol.DataObject
equals, hashCode, toString, toString
 
Methods inherited from class java.lang.Object
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 EventAuthenticated create()
Creates instance of EventAuthenticated with no parameters set.

Returns:
instance of EventAuthenticated

create

public static EventAuthenticated create(java.lang.String description)
Creates instance of EventAuthenticated with all parameters set.

Parameters:
description - Used for description of an error if type of event is error
Returns:
instance of EventAuthenticated

getReferenceId

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

Returns:
property value

setReferenceId

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

Parameters:
referenceId - new value of the property

setReferenceId

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

Parameters:
referenceId - 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

Configuration Platform SDK 7.6 API Reference

Send comments on this topic.
Copyright © 2006–2008 Genesys Telecommunication Laboratories, Inc. All rights reserved.