Platform SDK Java 8.5 API Reference

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

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.RequestCountInteractions
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 RequestCountInteractions
extends AbstractMessage

This request returns the number of Interactions that match the specified filter.

Required parameters:

Name Description
setTenantId(java.lang.Integer) The unique tenant ID.

Related Events:
Name Description
EventCountInteractions This event returns the number of Interactions that match the filter specified in the related RequestCountInteractions.
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
RequestCountInteractions()
           
 
Method Summary
 java.util.Map attributes()
           
static RequestCountInteractions create()
           
 com.genesyslab.platform.commons.protocol.runtime.DataSupport createClone(com.genesyslab.platform.commons.protocol.runtime.DataSupport sample)
           
 boolean equals(java.lang.Object obj)
           
 java.util.Map getCompounds()
           
 java.util.List getCustomPackagers()
           
 DataSourceType getDataSource()
          String value to identify whether the search should be processed in the "main" or "archive" UCS database.
 com.genesyslab.platform.commons.protocol.runtime.MetaData getMetaData()
           
 SearchCriteriaCollection getSearchCriteria()
          Filters the Interactions that should be returned.
 java.lang.String getSubscriberId()
          The subscriber (i.e. line of business) within the tenant to which the interactions belong to.
 java.lang.Integer getTenantId()
          Specifies which Tenant to count interactions from.
 int hashCode()
           
 void setDataSource(DataSourceType value)
          String value to identify whether the search should be processed in the "main" or "archive" UCS database.
 void setSearchCriteria(SearchCriteriaCollection value)
          Filters the Interactions that should be returned.
 void setSubscriberId(java.lang.String value)
          The subscriber (i.e. line of business) within the tenant to which the interactions belong to.
 void setTenantId(java.lang.Integer value)
          Specifies which Tenant to count interactions from.
 
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

RequestCountInteractions

public RequestCountInteractions()
Method Detail

create

public static RequestCountInteractions create()

getTenantId

public java.lang.Integer getTenantId()
Specifies which Tenant to count interactions from.


setTenantId

public void setTenantId(java.lang.Integer value)
Specifies which Tenant to count interactions from.


getSubscriberId

public java.lang.String getSubscriberId()
The subscriber (i.e. line of business) within the tenant to which the interactions belong to.


setSubscriberId

public void setSubscriberId(java.lang.String value)
The subscriber (i.e. line of business) within the tenant to which the interactions belong to.


getDataSource

public DataSourceType getDataSource()
String value to identify whether the search should be processed in the "main" or "archive" UCS database. Default value is "main".


setDataSource

public void setDataSource(DataSourceType value)
String value to identify whether the search should be processed in the "main" or "archive" UCS database. Default value is "main".


getSearchCriteria

public SearchCriteriaCollection getSearchCriteria()
Filters the Interactions that should be returned. No filtering is used if this parameter is not present.


setSearchCriteria

public void setSearchCriteria(SearchCriteriaCollection value)
Filters the Interactions that should be returned. No filtering is used if this parameter is not present.


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.