Platform SDK Java 8.5 API Reference

com.genesyslab.platform.contacts.protocol.contactserver.requests
Class RequestGetCategory

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.contacts.protocol.contactserver.AbstractMessage
              extended by com.genesyslab.platform.contacts.protocol.contactserver.requests.RequestGetCategory
All Implemented Interfaces:
EndpointSupport, ProtocolDescriptionSupport, Referenceable, com.genesyslab.platform.commons.protocol.runtime.DataSupport, com.genesyslab.platform.commons.protocol.runtime.UpdatableProtocolId, ContactServerMessage, Printable, RequestorInfoSupport

public final class RequestGetCategory
extends AbstractMessage

This request returns a specified category.

Required parameters:

Name Description
setCategoryId(java.lang.String) Specifies the category to return in EventGetCategory.

Related Events:
Name Description
EventGetCategory This event contains information about the requested category.
EventError Indicates that the request encountered an error.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Fields inherited from class com.genesyslab.platform.contacts.protocol.contactserver.AbstractMessage
REF_ID_KEY
 
Constructor Summary
RequestGetCategory()
           
 
Method Summary
 java.util.Map attributes()
           
static RequestGetCategory create()
           
 com.genesyslab.platform.commons.protocol.runtime.DataSupport createClone(com.genesyslab.platform.commons.protocol.runtime.DataSupport sample)
           
 boolean equals(java.lang.Object obj)
           
 java.lang.String getCategoryId()
          Specifies the category to return in EventGetCategory.
 java.util.Map getCompounds()
           
 java.util.List getCustomPackagers()
           
 com.genesyslab.platform.commons.protocol.runtime.MetaData getMetaData()
           
 java.lang.Boolean getReturnChildrenCategories()
          Boolean value indicating whether child categories should be returned in EventGetCategory.
 java.lang.Boolean getReturnChildrenSRInfo()
          Boolean value indicating whether a list of standard responses for child categories should be returned in EventGetCategory.
 int hashCode()
           
 void setCategoryId(java.lang.String value)
          Specifies the category to return in EventGetCategory.
 void setReturnChildrenCategories(java.lang.Boolean value)
          Boolean value indicating whether child categories should be returned in EventGetCategory.
 void setReturnChildrenSRInfo(java.lang.Boolean value)
          Boolean value indicating whether a list of standard responses for child categories should be returned in EventGetCategory.
 
Methods inherited from class com.genesyslab.platform.contacts.protocol.contactserver.AbstractMessage
getEndpoint, getLazyParser, getMessageAttribute, getProtocolId, getReferenceId, getRequestorInfo, retreiveReference, setEndpoint, setProtocolId, setReferenceId, setReferenceId, setRequestorInfo, toString, toString, toString, toString, updateReference
 
Methods inherited from class com.genesyslab.platform.commons.protocol.Message
cloneMessage, getProtocolDescription, messageId, messageName, setProtocolDescription
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.genesyslab.platform.commons.protocol.ProtocolDescriptionSupport
getProtocolDescription
 

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
Constructor Detail

RequestGetCategory

public RequestGetCategory()
Method Detail

create

public static RequestGetCategory create()

getCategoryId

public java.lang.String getCategoryId()
Specifies the category to return in EventGetCategory.


setCategoryId

public void setCategoryId(java.lang.String value)
Specifies the category to return in EventGetCategory.


getReturnChildrenCategories

public java.lang.Boolean getReturnChildrenCategories()
Boolean value indicating whether child categories should be returned in EventGetCategory.


setReturnChildrenCategories

public void setReturnChildrenCategories(java.lang.Boolean value)
Boolean value indicating whether child categories should be returned in EventGetCategory.


getReturnChildrenSRInfo

public java.lang.Boolean getReturnChildrenSRInfo()
Boolean value indicating whether a list of standard responses for child categories should be returned in EventGetCategory.


setReturnChildrenSRInfo

public void setReturnChildrenSRInfo(java.lang.Boolean value)
Boolean value indicating whether a list of standard responses for child categories should be returned in EventGetCategory.


getMetaData

public com.genesyslab.platform.commons.protocol.runtime.MetaData getMetaData()

getCustomPackagers

public java.util.List getCustomPackagers()
Specified by:
getCustomPackagers in interface com.genesyslab.platform.commons.protocol.runtime.DataSupport
Overrides:
getCustomPackagers in class AbstractMessage

attributes

public java.util.Map attributes()

getCompounds

public java.util.Map getCompounds()

createClone

public com.genesyslab.platform.commons.protocol.runtime.DataSupport createClone(com.genesyslab.platform.commons.protocol.runtime.DataSupport sample)

hashCode

public int hashCode()
Overrides:
hashCode in class DataObject

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class DataObject

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.