Package co.ecg.alpaca.toolkit.generated

Class CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedResponse>

co.ecg.alpaca.toolkit.generated.CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest

Enclosing class:

CallCenter

public static class CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest
extends Request<CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedResponse>

Gets an existing specified Call Center Agent Threshold Profile in an Enterprise. The agentTable is what the search, sort, and pagination fields apply to. If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by default, and the responsePageSize will be set to the maximum ResponsePageSize by default. It is possible to search by various criteria to restrict the number of rows returned. If no sortOrder is included the response is sorted by User Id ascending by default. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are logically ORed together. ErrorResponse is returned if searchCriteriaExactUserGroup has multiple entries and searchCriteriaModeOr is not included. The response is either a EnterpriseCallCenterAgentThresholdProfileGetPagedSortedResponse or an ErrorResponse.

Author:

AlpacaGenerator

Nested Class Summary

Nested classes/interfaces inherited from class co.ecg.alpaca.toolkit.messaging.request.Request

Request.Protocol

Field Summary

Fields

Modifier and Type	Field	Description
protected @NotNull @Valid Enterprise	enterprise
protected @NotNull @Size(min=1,max=40) String	profileName
protected @Valid ResponsePagingControl	responsePagingControl
protected @Valid SearchCriteriaDepartmentName[]	searchCriteriaDepartmentName
protected @Valid SearchCriteriaDn[]	searchCriteriaDn
protected @Valid SearchCriteriaEmailAddress[]	searchCriteriaEmailAddress
protected @Valid SearchCriteriaExactUserGroup[]	searchCriteriaExactUserGroup
protected @Valid SearchCriteriaExtension[]	searchCriteriaExtension
protected @Valid SearchCriteriaGroupName[]	searchCriteriaGroupName
protected @AssertTrue Boolean	searchCriteriaModeOr
protected @Valid SearchCriteriaUserFirstName[]	searchCriteriaUserFirstName
protected @Valid SearchCriteriaUserId[]	searchCriteriaUserId
protected @Valid SearchCriteriaUserLastName[]	searchCriteriaUserLastName
protected @Valid @Size(max=3) SortOrderEnterpriseCallCenterAgentThresholdProfileGetPagedSorted[]	sortOrder

Fields inherited from class co.ecg.alpaca.toolkit.messaging.request.Request

log

Constructor Summary

Constructors

Constructor	Description
EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest()
EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest(Enterprise enterprise, String profileName)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Enterprise	getEnterprise()
String	getProfileName()
ResponsePagingControl	getResponsePagingControl()
SearchCriteriaDepartmentName[]	getSearchCriteriaDepartmentName()
SearchCriteriaDn[]	getSearchCriteriaDn()
SearchCriteriaEmailAddress[]	getSearchCriteriaEmailAddress()
SearchCriteriaExactUserGroup[]	getSearchCriteriaExactUserGroup()
SearchCriteriaExtension[]	getSearchCriteriaExtension()
SearchCriteriaGroupName[]	getSearchCriteriaGroupName()
Boolean	getSearchCriteriaModeOr()
SearchCriteriaUserFirstName[]	getSearchCriteriaUserFirstName()
SearchCriteriaUserId[]	getSearchCriteriaUserId()
SearchCriteriaUserLastName[]	getSearchCriteriaUserLastName()
SortOrderEnterpriseCallCenterAgentThresholdProfileGetPagedSorted[]	getSortOrder()
boolean	searchCriteriaModeOrFlagExist()
CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest	setEnterprise(Enterprise enterprise)
CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest	setFlagSearchCriteriaModeOr()
CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest	setProfileName(String profileName)
CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest	setResponsePagingControl(ResponsePagingControl responsePagingControl)
CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest	setSearchCriteriaDepartmentName(SearchCriteriaDepartmentName... searchCriteriaDepartmentName)
CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest	setSearchCriteriaEmailAddress(SearchCriteriaEmailAddress... searchCriteriaEmailAddress)
CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest	setSearchCriteriaExactUserGroup(SearchCriteriaExactUserGroup... searchCriteriaExactUserGroup)
CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest	setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)
CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest	setSearchCriteriaGroupName(SearchCriteriaGroupName... searchCriteriaGroupName)
CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest	setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)
CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest	setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)
CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest	setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)
CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest	setSortOrder(SortOrderEnterpriseCallCenterAgentThresholdProfileGetPagedSorted... sortOrder)

Methods inherited from class co.ecg.alpaca.toolkit.messaging.request.Request

appendChild, appendChild, appendChild, asyncFire, createElement, createNilElement, createNilElement, createTextElement, equals, fire, fire, getBroadWorksServer, getCacheString, getCommandElement, getCommandType, getDomDocument, getId, getOCSProtocol, getRequestTimeoutMillis, getResponseClass, getRetries, getRetryCodes, getRootElement, getValidationErrorsAsString, hashCode, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setEcho, setMemberOfBundle, setRequestId, setRequestTimeoutMillis, setResponseClass, setRetries, setRetryCodes, setRootElement, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

enterprise

@NotNull @Valid protected transient @NotNull @Valid Enterprise enterprise

profileName

@NotNull @Size(min=1, max=40) protected @NotNull @Size(min=1,max=40) String profileName

responsePagingControl

@Valid protected @Valid ResponsePagingControl responsePagingControl

sortOrder

@Valid @Size(max=3) protected @Valid @Size(max=3) SortOrderEnterpriseCallCenterAgentThresholdProfileGetPagedSorted[] sortOrder

searchCriteriaUserId

@Valid protected @Valid SearchCriteriaUserId[] searchCriteriaUserId

searchCriteriaUserLastName

@Valid protected @Valid SearchCriteriaUserLastName[] searchCriteriaUserLastName

searchCriteriaUserFirstName

@Valid protected @Valid SearchCriteriaUserFirstName[] searchCriteriaUserFirstName

searchCriteriaDn

@Valid protected @Valid SearchCriteriaDn[] searchCriteriaDn

searchCriteriaExtension

@Valid protected @Valid SearchCriteriaExtension[] searchCriteriaExtension

searchCriteriaDepartmentName

@Valid protected @Valid SearchCriteriaDepartmentName[] searchCriteriaDepartmentName

searchCriteriaExactUserGroup

@Valid protected @Valid SearchCriteriaExactUserGroup[] searchCriteriaExactUserGroup

searchCriteriaGroupName

@Valid protected @Valid SearchCriteriaGroupName[] searchCriteriaGroupName

searchCriteriaEmailAddress

@Valid protected @Valid SearchCriteriaEmailAddress[] searchCriteriaEmailAddress

searchCriteriaModeOr

@AssertTrue protected @AssertTrue Boolean searchCriteriaModeOr

Constructor Details

EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest

public EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest()

EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest

public EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest(Enterprise enterprise, String profileName)

Method Details

setEnterprise

public CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest setEnterprise(Enterprise enterprise)

getEnterprise

public Enterprise getEnterprise()

setProfileName

public CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest setProfileName(String profileName)

getProfileName

public String getProfileName()

setResponsePagingControl

public CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest setResponsePagingControl(ResponsePagingControl responsePagingControl)

getResponsePagingControl

public ResponsePagingControl getResponsePagingControl()

setSortOrder

public CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest setSortOrder(SortOrderEnterpriseCallCenterAgentThresholdProfileGetPagedSorted... sortOrder)

getSortOrder

public SortOrderEnterpriseCallCenterAgentThresholdProfileGetPagedSorted[] getSortOrder()

setSearchCriteriaUserId

public CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)

getSearchCriteriaUserId

public SearchCriteriaUserId[] getSearchCriteriaUserId()

setSearchCriteriaUserLastName

public CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)

getSearchCriteriaUserLastName

public SearchCriteriaUserLastName[] getSearchCriteriaUserLastName()

setSearchCriteriaUserFirstName

public CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)

getSearchCriteriaUserFirstName

public SearchCriteriaUserFirstName[] getSearchCriteriaUserFirstName()

setSearchCriteriaDn

public CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaExtension

public CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)

getSearchCriteriaExtension

public SearchCriteriaExtension[] getSearchCriteriaExtension()

setSearchCriteriaDepartmentName

public CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest setSearchCriteriaDepartmentName(SearchCriteriaDepartmentName... searchCriteriaDepartmentName)

getSearchCriteriaDepartmentName

public SearchCriteriaDepartmentName[] getSearchCriteriaDepartmentName()

setSearchCriteriaExactUserGroup

public CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest setSearchCriteriaExactUserGroup(SearchCriteriaExactUserGroup... searchCriteriaExactUserGroup)

getSearchCriteriaExactUserGroup

public SearchCriteriaExactUserGroup[] getSearchCriteriaExactUserGroup()

setSearchCriteriaGroupName

public CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest setSearchCriteriaGroupName(SearchCriteriaGroupName... searchCriteriaGroupName)

getSearchCriteriaGroupName

public SearchCriteriaGroupName[] getSearchCriteriaGroupName()

setSearchCriteriaEmailAddress

public CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest setSearchCriteriaEmailAddress(SearchCriteriaEmailAddress... searchCriteriaEmailAddress)

getSearchCriteriaEmailAddress

public SearchCriteriaEmailAddress[] getSearchCriteriaEmailAddress()

setFlagSearchCriteriaModeOr

public CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest setFlagSearchCriteriaModeOr()

searchCriteriaModeOrFlagExist

public boolean searchCriteriaModeOrFlagExist()

getSearchCriteriaModeOr

public Boolean getSearchCriteriaModeOr()

getEmptyObject

public static CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest getEmptyObject(BroadWorksServer broadWorksServer)

Retrieves this object with minimal setup.

Parameters:

broadWorksServer - The BroadWorksServer

formRequest

public void formRequest()

Forms the XML Document for this Request Object. Called by the Request upon fire().

Overrides:

formRequest in class Request<CallCenter.EnterpriseCallCenterAgentThresholdProfileGetPagedSortedResponse>