Package co.ecg.alpaca.toolkit.generated

Class CallCenter.EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.CallCenter.EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListRequest

Enclosing class:

CallCenter

public static class CallCenter.EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListRequest
extends Request<CallCenter.EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListResponse>

Get the list of all Agents in the Enterprise that can be assigned to a given Call Center Agent Threshold Profile in an Enterprise. An agent is available to be assigned to a given Agent Threshold Profile if it is a Call Center Standard or Call Center Premium agent and the agent is not yet assigned to the profile. The available agent list for a new Call Center Agent Threshold profile can be obtained by not setting the excludeAgentsAssignedToProfileName. When the excludeAgentsAssignedToProfileName is specified, all agents already assigned to the specified profile are not included in the response, even if the search criterion element searchCriteriaAgentThresholdProfile is specified using the same profile name. The response is either a EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListResponse 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 @Size(min=1,max=40) String	excludeAgentsAssignedToProfileName
protected Integer	responseSizeLimit
protected @Valid SearchCriteriaAgentThresholdProfile[]	searchCriteriaAgentThresholdProfile
protected @Valid SearchCriteriaDn[]	searchCriteriaDn
protected @Valid SearchCriteriaExactUserDepartment	searchCriteriaExactUserDepartment
protected @Valid SearchCriteriaExactUserGroup	searchCriteriaExactUserGroup
protected @Valid SearchCriteriaExtension[]	searchCriteriaExtension
protected @Valid SearchCriteriaUserFirstName[]	searchCriteriaUserFirstName
protected @Valid SearchCriteriaUserId[]	searchCriteriaUserId
protected @Valid SearchCriteriaUserLastName[]	searchCriteriaUserLastName

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

log

Constructor Summary

Constructors

Constructor	Description
EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListRequest()
EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListRequest(Enterprise enterprise)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static CallCenter.EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Enterprise	getEnterprise()
String	getExcludeAgentsAssignedToProfileName()
Integer	getResponseSizeLimit()
SearchCriteriaAgentThresholdProfile[]	getSearchCriteriaAgentThresholdProfile()
SearchCriteriaDn[]	getSearchCriteriaDn()
SearchCriteriaExactUserDepartment	getSearchCriteriaExactUserDepartment()
SearchCriteriaExactUserGroup	getSearchCriteriaExactUserGroup()
SearchCriteriaExtension[]	getSearchCriteriaExtension()
SearchCriteriaUserFirstName[]	getSearchCriteriaUserFirstName()
SearchCriteriaUserId[]	getSearchCriteriaUserId()
SearchCriteriaUserLastName[]	getSearchCriteriaUserLastName()
CallCenter.EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListRequest	setEnterprise(Enterprise enterprise)
CallCenter.EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListRequest	setExcludeAgentsAssignedToProfileName(String excludeAgentsAssignedToProfileName)
CallCenter.EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListRequest	setResponseSizeLimit(Integer responseSizeLimit)
CallCenter.EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListRequest	setSearchCriteriaAgentThresholdProfile(SearchCriteriaAgentThresholdProfile... searchCriteriaAgentThresholdProfile)
CallCenter.EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
CallCenter.EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListRequest	setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)
CallCenter.EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListRequest	setSearchCriteriaExactUserGroup(SearchCriteriaExactUserGroup searchCriteriaExactUserGroup)
CallCenter.EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListRequest	setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)
CallCenter.EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListRequest	setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)
CallCenter.EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListRequest	setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)
CallCenter.EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListRequest	setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)

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, isIgnoreCache, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setEcho, setIgnoreCache, 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

excludeAgentsAssignedToProfileName

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

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaUserLastName

@Valid
protected @Valid SearchCriteriaUserLastName[] searchCriteriaUserLastName

searchCriteriaUserFirstName

@Valid
protected @Valid SearchCriteriaUserFirstName[] searchCriteriaUserFirstName

searchCriteriaExactUserDepartment

@Valid
protected @Valid SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment

searchCriteriaExactUserGroup

@Valid
protected @Valid SearchCriteriaExactUserGroup searchCriteriaExactUserGroup

searchCriteriaUserId

@Valid
protected @Valid SearchCriteriaUserId[] searchCriteriaUserId

searchCriteriaDn

@Valid
protected @Valid SearchCriteriaDn[] searchCriteriaDn

searchCriteriaExtension

@Valid
protected @Valid SearchCriteriaExtension[] searchCriteriaExtension

searchCriteriaAgentThresholdProfile

@Valid
protected @Valid SearchCriteriaAgentThresholdProfile[] searchCriteriaAgentThresholdProfile

Constructor Details

EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListRequest

public EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListRequest()

EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListRequest

public EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListRequest(Enterprise enterprise)

Method Details

setEnterprise

public CallCenter.EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListRequest setEnterprise(Enterprise enterprise)

getEnterprise

public Enterprise getEnterprise()

setExcludeAgentsAssignedToProfileName

public CallCenter.EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListRequest setExcludeAgentsAssignedToProfileName(String excludeAgentsAssignedToProfileName)

getExcludeAgentsAssignedToProfileName

public String getExcludeAgentsAssignedToProfileName()

setResponseSizeLimit

public CallCenter.EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaUserLastName

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

getSearchCriteriaUserLastName

public SearchCriteriaUserLastName[] getSearchCriteriaUserLastName()

setSearchCriteriaUserFirstName

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

getSearchCriteriaUserFirstName

public SearchCriteriaUserFirstName[] getSearchCriteriaUserFirstName()

setSearchCriteriaExactUserDepartment

public CallCenter.EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListRequest setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)

getSearchCriteriaExactUserDepartment

public SearchCriteriaExactUserDepartment getSearchCriteriaExactUserDepartment()

setSearchCriteriaExactUserGroup

public CallCenter.EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListRequest setSearchCriteriaExactUserGroup(SearchCriteriaExactUserGroup searchCriteriaExactUserGroup)

getSearchCriteriaExactUserGroup

public SearchCriteriaExactUserGroup getSearchCriteriaExactUserGroup()

setSearchCriteriaUserId

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

getSearchCriteriaUserId

public SearchCriteriaUserId[] getSearchCriteriaUserId()

setSearchCriteriaDn

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

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaExtension

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

getSearchCriteriaExtension

public SearchCriteriaExtension[] getSearchCriteriaExtension()

setSearchCriteriaAgentThresholdProfile

public CallCenter.EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListRequest setSearchCriteriaAgentThresholdProfile(SearchCriteriaAgentThresholdProfile... searchCriteriaAgentThresholdProfile)

getSearchCriteriaAgentThresholdProfile

public SearchCriteriaAgentThresholdProfile[] getSearchCriteriaAgentThresholdProfile()

getEmptyObject

public static CallCenter.EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListRequest 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.EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListResponse>