Platform SDK Java 8.5 API Reference

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

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

This request is intended for checking whether standard responses were updated or not since the time, provided as a time-stamp.

Required parameters:

Name Description
setTenantId(java.lang.Integer) The unique Tenant ID.
setLanguage(java.lang.String) Language configured in Configuration Manager.
setLastUpdate(java.util.Date) Time-stamp from the last update (in format "yyyy-MM-ddTHH:mm:ss.SSSZ").

Related Events:
Name Description
EventCheckForUpdates This event indicates whether or not standard responses were updated since the requested time.
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
RequestCheckForUpdates()
           
 
Method Summary
 java.util.Map attributes()
           
static RequestCheckForUpdates 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()
           
 java.lang.String getLanguage()
          Language configured in Configuration Manager.
 java.util.Date getLastUpdate()
          Time-stamp from the last update (in format "yyyy-MM-ddTHH:mm:ss.SSSZ").
 com.genesyslab.platform.commons.protocol.runtime.MetaData getMetaData()
           
 java.lang.String getSubscriberId()
          The subscriber (i.e. customer) within the tenant to which the category roots should belong to.
 java.lang.Integer getTenantId()
          Tenant ID.
 int hashCode()
           
 void setLanguage(java.lang.String value)
          Language configured in Configuration Manager.
 void setLastUpdate(java.util.Date value)
          Time-stamp from the last update (in format "yyyy-MM-ddTHH:mm:ss.SSSZ").
 void setSubscriberId(java.lang.String value)
          The subscriber (i.e. customer) within the tenant to which the category roots should belong to.
 void setTenantId(java.lang.Integer value)
          Tenant ID.
 
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

RequestCheckForUpdates

public RequestCheckForUpdates()
Method Detail

create

public static RequestCheckForUpdates create()

getLanguage

public java.lang.String getLanguage()
Language configured in Configuration Manager.


setLanguage

public void setLanguage(java.lang.String value)
Language configured in Configuration Manager.


getTenantId

public java.lang.Integer getTenantId()
Tenant ID.


setTenantId

public void setTenantId(java.lang.Integer value)
Tenant ID.


getSubscriberId

public java.lang.String getSubscriberId()
The subscriber (i.e. customer) within the tenant to which the category roots should belong to.


setSubscriberId

public void setSubscriberId(java.lang.String value)
The subscriber (i.e. customer) within the tenant to which the category roots should belong to.


getLastUpdate

public java.util.Date getLastUpdate()
Time-stamp from the last update (in format "yyyy-MM-ddTHH:mm:ss.SSSZ").


setLastUpdate

public void setLastUpdate(java.util.Date value)
Time-stamp from the last update (in format "yyyy-MM-ddTHH:mm:ss.SSSZ").


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.