Platform SDK Java 8.5 API Reference

com.genesyslab.platform.contacts.protocol.contactserver
Class SortCriteria

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.contacts.protocol.contactserver.AbstractPrintable
          extended by com.genesyslab.platform.contacts.protocol.contactserver.SortCriteria
All Implemented Interfaces:
Printable, XmlSerializable

public final class SortCriteria
extends AbstractPrintable
implements XmlSerializable, Printable

String that represents either a Contact object attribute name ("Id", "TenantId", "IsExternalResource", "CreatedDate", "ModifiedDate", "MergeId") or a sortable Contact Attribute system name.

Note: To make a Contact Attribute sortable, you must configure that Contact Attribute as sortable (settings/is-sortable) in ConfigServer. EmailAddress, PhoneNumber, FirstName and LastName are sortable by default.


Field Summary
 
Fields inherited from class com.genesyslab.platform.contacts.protocol.contactserver.AbstractPrintable
SUPRESSED
 
Constructor Summary
SortCriteria()
           
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 java.lang.String getAttrName()
           
 java.lang.Integer getSortIndex()
           
 SortMode getSortOperator()
          Can have value of 'Ascending' or 'Descending'.
 int hashCode()
           
 void loadFromXml(UCSCustomCodec custCodec, org.w3c.dom.Node node)
           
 void saveToXml(UCSCustomCodec custCodec, org.w3c.dom.Node node)
           
 void setAttrName(java.lang.String value)
           
 void setSortIndex(java.lang.Integer value)
           
 void setSortOperator(SortMode value)
          Can have value of 'Ascending' or 'Descending'.
 java.lang.String toString(int indent, boolean hideAllowed, boolean truncateLargeData)
           
 
Methods inherited from class com.genesyslab.platform.contacts.protocol.contactserver.AbstractPrintable
createIndent, toString, toString, toString, toString
 
Methods inherited from class com.genesyslab.platform.commons.protocol.DataObject
toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.genesyslab.platform.contacts.protocol.contactserver.Printable
toString
 

Constructor Detail

SortCriteria

public SortCriteria()
Method Detail

getAttrName

public java.lang.String getAttrName()

setAttrName

public void setAttrName(java.lang.String value)

getSortIndex

public java.lang.Integer getSortIndex()

setSortIndex

public void setSortIndex(java.lang.Integer value)

getSortOperator

public SortMode getSortOperator()
Can have value of 'Ascending' or 'Descending'.


setSortOperator

public void setSortOperator(SortMode value)
Can have value of 'Ascending' or 'Descending'.


saveToXml

public void saveToXml(UCSCustomCodec custCodec,
                      org.w3c.dom.Node node)
               throws com.genesyslab.platform.commons.protocol.runtime.codec.CodecException
Specified by:
saveToXml in interface XmlSerializable
Throws:
com.genesyslab.platform.commons.protocol.runtime.codec.CodecException

loadFromXml

public void loadFromXml(UCSCustomCodec custCodec,
                        org.w3c.dom.Node node)
                 throws com.genesyslab.platform.commons.protocol.runtime.codec.CodecException
Specified by:
loadFromXml in interface XmlSerializable
Throws:
com.genesyslab.platform.commons.protocol.runtime.codec.CodecException

toString

public java.lang.String toString(int indent,
                                 boolean hideAllowed,
                                 boolean truncateLargeData)
Specified by:
toString in class AbstractPrintable

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.