Platform SDK Java 8.5 API Reference

com.genesyslab.platform.management.protocol.messageserver.requests.subscription
Class RequestUnsubscribeTypeKey

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.subscription.RequestUnsubscribeTypeKey
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestUnsubscribeTypeKey
extends Message

Unsubscribes by type and key


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestUnsubscribeTypeKey create()
          Creates instance of RequestUnsubscribeTypeKey with no parameters set.
static RequestUnsubscribeTypeKey create(MessagePriority priority, java.lang.Integer subscriberType, 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  MessagePriority getPriority()
          Priority of the message
abstract  java.lang.Integer getSubscriberType()
          Subscription: Type of the message to subscribe to
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
abstract  void setPriority(MessagePriority priority)
          Priority of the message
abstract  void setSubscriberType(int subscriberType)
          Subscription: Type of the message to subscribe to
abstract  void setSubscriberType(java.lang.Integer subscriberType)
          Subscription: Type of the message to subscribe to
 
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 RequestUnsubscribeTypeKey create()
Creates instance of RequestUnsubscribeTypeKey with no parameters set.

Returns:
instance of RequestUnsubscribeTypeKey

create

public static RequestUnsubscribeTypeKey create(MessagePriority priority,
                                               java.lang.Integer subscriberType,
                                               java.lang.Integer keyFlags,
                                               java.lang.Integer keyInteger,
                                               java.lang.Integer keyLong,
                                               java.lang.String keyString)
Deprecated. use other create method

Creates instance of RequestUnsubscribeTypeKey.

Parameters:
priority - Priority of the message
subscriberType - Subscription: Type of the message to subscribe to
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 RequestUnsubscribeTypeKey

getPriority

public abstract MessagePriority getPriority()
Priority of the message

Returns:
property value

setPriority

public abstract void setPriority(MessagePriority priority)
Priority of the message

Parameters:
priority - new value of the property

getSubscriberType

public abstract java.lang.Integer getSubscriberType()
Subscription: Type of the message to subscribe to

Returns:
property value

setSubscriberType

public abstract void setSubscriberType(java.lang.Integer subscriberType)
Subscription: Type of the message to subscribe to

Parameters:
subscriberType - new value of the property

setSubscriberType

public abstract void setSubscriberType(int subscriberType)
Subscription: Type of the message to subscribe to

Parameters:
subscriberType - new value of the property

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.