public class CurrentMetricSortCriteria
extends java.lang.Object
implements java.io.Serializable
The way to sort the resulting response based on metrics. By default resources
are sorted based on AGENTS_ONLINE, DESCENDING. The
metric collection is sorted based on the input metrics.
| Constructor and Description |
|---|
CurrentMetricSortCriteria() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getSortByMetric()
The current metric names.
|
java.lang.String |
getSortOrder()
The way to sort.
|
int |
hashCode() |
void |
setSortByMetric(CurrentMetricName sortByMetric)
The current metric names.
|
void |
setSortByMetric(java.lang.String sortByMetric)
The current metric names.
|
void |
setSortOrder(SortOrder sortOrder)
The way to sort.
|
void |
setSortOrder(java.lang.String sortOrder)
The way to sort.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
CurrentMetricSortCriteria |
withSortByMetric(CurrentMetricName sortByMetric)
The current metric names.
|
CurrentMetricSortCriteria |
withSortByMetric(java.lang.String sortByMetric)
The current metric names.
|
CurrentMetricSortCriteria |
withSortOrder(SortOrder sortOrder)
The way to sort.
|
CurrentMetricSortCriteria |
withSortOrder(java.lang.String sortOrder)
The way to sort.
|
public java.lang.String getSortByMetric()
The current metric names.
Constraints:
Allowed Values: AGENTS_ONLINE, AGENTS_AVAILABLE, AGENTS_ON_CALL,
AGENTS_NON_PRODUCTIVE, AGENTS_AFTER_CONTACT_WORK, AGENTS_ERROR,
AGENTS_STAFFED, CONTACTS_IN_QUEUE, OLDEST_CONTACT_AGE,
CONTACTS_SCHEDULED, AGENTS_ON_CONTACT, SLOTS_ACTIVE, SLOTS_AVAILABLE
The current metric names.
CurrentMetricNamepublic void setSortByMetric(java.lang.String sortByMetric)
The current metric names.
Constraints:
Allowed Values: AGENTS_ONLINE, AGENTS_AVAILABLE, AGENTS_ON_CALL,
AGENTS_NON_PRODUCTIVE, AGENTS_AFTER_CONTACT_WORK, AGENTS_ERROR,
AGENTS_STAFFED, CONTACTS_IN_QUEUE, OLDEST_CONTACT_AGE,
CONTACTS_SCHEDULED, AGENTS_ON_CONTACT, SLOTS_ACTIVE, SLOTS_AVAILABLE
sortByMetric - The current metric names.
CurrentMetricNamepublic CurrentMetricSortCriteria withSortByMetric(java.lang.String sortByMetric)
The current metric names.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: AGENTS_ONLINE, AGENTS_AVAILABLE, AGENTS_ON_CALL,
AGENTS_NON_PRODUCTIVE, AGENTS_AFTER_CONTACT_WORK, AGENTS_ERROR,
AGENTS_STAFFED, CONTACTS_IN_QUEUE, OLDEST_CONTACT_AGE,
CONTACTS_SCHEDULED, AGENTS_ON_CONTACT, SLOTS_ACTIVE, SLOTS_AVAILABLE
sortByMetric - The current metric names.
CurrentMetricNamepublic void setSortByMetric(CurrentMetricName sortByMetric)
The current metric names.
Constraints:
Allowed Values: AGENTS_ONLINE, AGENTS_AVAILABLE, AGENTS_ON_CALL,
AGENTS_NON_PRODUCTIVE, AGENTS_AFTER_CONTACT_WORK, AGENTS_ERROR,
AGENTS_STAFFED, CONTACTS_IN_QUEUE, OLDEST_CONTACT_AGE,
CONTACTS_SCHEDULED, AGENTS_ON_CONTACT, SLOTS_ACTIVE, SLOTS_AVAILABLE
sortByMetric - The current metric names.
CurrentMetricNamepublic CurrentMetricSortCriteria withSortByMetric(CurrentMetricName sortByMetric)
The current metric names.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: AGENTS_ONLINE, AGENTS_AVAILABLE, AGENTS_ON_CALL,
AGENTS_NON_PRODUCTIVE, AGENTS_AFTER_CONTACT_WORK, AGENTS_ERROR,
AGENTS_STAFFED, CONTACTS_IN_QUEUE, OLDEST_CONTACT_AGE,
CONTACTS_SCHEDULED, AGENTS_ON_CONTACT, SLOTS_ACTIVE, SLOTS_AVAILABLE
sortByMetric - The current metric names.
CurrentMetricNamepublic java.lang.String getSortOrder()
The way to sort.
Constraints:
Allowed Values: ASCENDING, DESCENDING
The way to sort.
SortOrderpublic void setSortOrder(java.lang.String sortOrder)
The way to sort.
Constraints:
Allowed Values: ASCENDING, DESCENDING
sortOrder - The way to sort.
SortOrderpublic CurrentMetricSortCriteria withSortOrder(java.lang.String sortOrder)
The way to sort.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: ASCENDING, DESCENDING
sortOrder - The way to sort.
SortOrderpublic void setSortOrder(SortOrder sortOrder)
The way to sort.
Constraints:
Allowed Values: ASCENDING, DESCENDING
sortOrder - The way to sort.
SortOrderpublic CurrentMetricSortCriteria withSortOrder(SortOrder sortOrder)
The way to sort.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: ASCENDING, DESCENDING
sortOrder - The way to sort.
SortOrderpublic java.lang.String toString()
toString in class java.lang.ObjectObject.toString()public int hashCode()
hashCode in class java.lang.Objectpublic boolean equals(java.lang.Object obj)
equals in class java.lang.Object