Platform SDK Java 8.5 API Reference

com.genesyslab.platform.management.protocol.messageserver.requests
Class RequestLogMessage

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.messageserver.requests.RequestLogMessage
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestLogMessage
extends Message

Requests that the Message Server issues a log message.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestLogMessage create()
          Creates instance of RequestLogMessage with no parameters set.
static RequestLogMessage create(java.lang.Integer entryId, java.lang.String entryText, LogLevel level)
          Creates instance of RequestLogMessage.
static RequestLogMessage create(java.lang.Integer entryId, java.lang.String entryText, LogLevel level, LogCategory entryCategory, java.util.Date time, java.lang.String clientHost)
          Deprecated. use other create methods
static RequestLogMessage create(java.lang.Integer entryId, java.lang.String entryText, LogLevel level, LogCategory entryCategory, java.util.Date time, java.lang.String clientHost, AttributeList attributes)
          Creates instance of RequestLogMessage.
abstract  AttributeList getAttributes()
          Attributes for interaction support
abstract  java.lang.String getClientHost()
           
abstract  LogCategory getEntryCategory()
           
abstract  java.lang.Integer getEntryId()
           
abstract  java.lang.String getEntryText()
           
abstract  LogLevel getLevel()
           
abstract  java.util.Date getTime()
          Note that server sends this value in UTC format always.
abstract  void setAttributes(AttributeList attributes)
          Attributes for interaction support
abstract  void setClientHost(java.lang.String clientHost)
           
abstract  void setEntryCategory(LogCategory entryCategory)
           
abstract  void setEntryId(int entryId)
           
abstract  void setEntryId(java.lang.Integer entryId)
           
abstract  void setEntryText(java.lang.String entryText)
           
abstract  void setLevel(LogLevel level)
           
abstract  void setTime(java.util.Date time)
          Note that server sends this value in UTC format always.
 
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 RequestLogMessage create()
Creates instance of RequestLogMessage with no parameters set.

Returns:
instance of RequestLogMessage

create

public static RequestLogMessage create(java.lang.Integer entryId,
                                       java.lang.String entryText,
                                       LogLevel level,
                                       LogCategory entryCategory,
                                       java.util.Date time,
                                       java.lang.String clientHost)
Deprecated. use other create methods

Creates instance of RequestLogMessage.

Parameters:
entryId - EntryId
entryText - EntryText
level - Level
entryCategory - EntryCategory
time - Note that server sends this value in UTC format always.
clientHost - ClientHost
Returns:
instance of RequestLogMessage

create

public static RequestLogMessage create(java.lang.Integer entryId,
                                       java.lang.String entryText,
                                       LogLevel level)
Creates instance of RequestLogMessage.

Parameters:
entryId - EntryId
entryText - EntryText
level - Level
Returns:
instance of RequestLogMessage

create

public static RequestLogMessage create(java.lang.Integer entryId,
                                       java.lang.String entryText,
                                       LogLevel level,
                                       LogCategory entryCategory,
                                       java.util.Date time,
                                       java.lang.String clientHost,
                                       AttributeList attributes)
Creates instance of RequestLogMessage.

Parameters:
entryId - EntryId
entryText - EntryText
level - Level
entryCategory - EntryCategory
time - Note that server sends this value in UTC format always.
clientHost - ClientHost
attributes - Attributes for interaction support
Returns:
instance of RequestLogMessage

getEntryId

public abstract java.lang.Integer getEntryId()

setEntryId

public abstract void setEntryId(java.lang.Integer entryId)

setEntryId

public abstract void setEntryId(int entryId)

getEntryText

public abstract java.lang.String getEntryText()

setEntryText

public abstract void setEntryText(java.lang.String entryText)

getLevel

public abstract LogLevel getLevel()

setLevel

public abstract void setLevel(LogLevel level)

getEntryCategory

public abstract LogCategory getEntryCategory()

setEntryCategory

public abstract void setEntryCategory(LogCategory entryCategory)

getTime

public abstract java.util.Date getTime()
Note that server sends this value in UTC format always.

Returns:
property value

setTime

public abstract void setTime(java.util.Date time)
Note that server sends this value in UTC format always.

Parameters:
time - new value of the property

getClientHost

public abstract java.lang.String getClientHost()

setClientHost

public abstract void setClientHost(java.lang.String clientHost)

getAttributes

public abstract AttributeList getAttributes()
Attributes for interaction support

Returns:
property value

setAttributes

public abstract void setAttributes(AttributeList attributes)
Attributes for interaction support

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