Platform SDK Java 8.5 API Reference

com.genesyslab.platform.management.protocol.messageserver
Class MessageKey

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.management.protocol.messageserver.MessageKey
All Implemented Interfaces:
ProtocolDescriptionSupport

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

MessageKey class.


Constructor Summary
MessageKey()
           
 
Method Summary
static MessageKey create()
          Creates instance of MessageKey with no parameters set.
static MessageKey create(java.lang.Integer keyFlags, java.lang.Integer keyInteger, java.lang.Integer keyLong, java.lang.String keyString)
          Deprecated. use other create method
abstract  java.lang.Integer getKeyFlags()
          Simple key: flags.
abstract  java.lang.Integer getKeyInteger()
          Simple key: integer value
abstract  KeyValueCollection getKeyKVList()
          KVList key
abstract  java.lang.Integer getKeyLong()
          Simple key: unsigned long value
abstract  java.lang.String getKeyString()
          Simple key: string value
abstract  void setKeyFlags(int keyFlags)
          Simple key: flags.
abstract  void setKeyFlags(java.lang.Integer keyFlags)
          Simple key: flags.
abstract  void setKeyInteger(int keyInteger)
          Simple key: integer value
abstract  void setKeyInteger(java.lang.Integer keyInteger)
          Simple key: integer value
abstract  void setKeyKVList(KeyValueCollection keyKVList)
          KVList key
abstract  void setKeyLong(int keyLong)
          Simple key: unsigned long value
abstract  void setKeyLong(java.lang.Integer keyLong)
          Simple key: unsigned long value
abstract  void setKeyString(java.lang.String keyString)
          Simple key: string value
 
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

MessageKey

public MessageKey()
Method Detail

create

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

Returns:
instance of MessageKey

create

public static MessageKey create(java.lang.Integer keyFlags,
                                java.lang.Integer keyInteger,
                                java.lang.Integer keyLong,
                                java.lang.String keyString)
Deprecated. use other create method

Creates instance of MessageKey.

Parameters:
keyFlags - Simple key: flags. Can be any combination of KeyFlags enum values (using bitwise OR operator '|')
keyInteger - Simple key: integer value
keyLong - Simple key: unsigned long value
keyString - Simple key: string value
Returns:
instance of MessageKey

getKeyFlags

public abstract java.lang.Integer getKeyFlags()
Simple key: flags. Can be any combination of KeyFlags enum values (using bitwise OR operator '|').

See Also:
KeyFlags

setKeyFlags

public abstract void setKeyFlags(java.lang.Integer keyFlags)
Simple key: flags. Can be any combination of KeyFlags enum values (using bitwise OR operator '|').

See Also:
KeyFlags

setKeyFlags

public abstract void setKeyFlags(int keyFlags)
Simple key: flags. Can be any combination of KeyFlags enum values (using bitwise OR operator '|').

See Also:
KeyFlags

getKeyInteger

public abstract java.lang.Integer getKeyInteger()
Simple key: integer value

Returns:
property value

setKeyInteger

public abstract void setKeyInteger(java.lang.Integer keyInteger)
Simple key: integer value

Parameters:
keyInteger - new value of the property

setKeyInteger

public abstract void setKeyInteger(int keyInteger)
Simple key: integer value

Parameters:
keyInteger - new value of the property

getKeyLong

public abstract java.lang.Integer getKeyLong()
Simple key: unsigned long value

Returns:
property value

setKeyLong

public abstract void setKeyLong(java.lang.Integer keyLong)
Simple key: unsigned long value

Parameters:
keyLong - new value of the property

setKeyLong

public abstract void setKeyLong(int keyLong)
Simple key: unsigned long value

Parameters:
keyLong - new value of the property

getKeyString

public abstract java.lang.String getKeyString()
Simple key: string value

Returns:
property value

setKeyString

public abstract void setKeyString(java.lang.String keyString)
Simple key: string value

Parameters:
keyString - new value of the property

getKeyKVList

public abstract KeyValueCollection getKeyKVList()
KVList key

Returns:
property value

setKeyKVList

public abstract void setKeyKVList(KeyValueCollection keyKVList)
KVList key

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