Package co.ecg.alpaca.toolkit.generated

Class CallCenter.UserCallCenterGetSupervisedAgentListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.CallCenter.UserCallCenterGetSupervisedAgentListRequest

Enclosing class:

CallCenter

public static class CallCenter.UserCallCenterGetSupervisedAgentListRequest
extends Request<CallCenter.UserCallCenterGetSupervisedAgentListResponse>

Get a list of agents supervised by a supervisor on a given call center. The response is either a UserCallCenterGetSupervisedAgentListResponse or an ErrorResponse. The search can be done using multiple criterias. If the searchCriteriaModeOr is present, any result matching any one criteria is included in the results. Otherwise, only results matching all the search criterias are included in the results. If no search criteria is specified, all results are returned. In all cases, if a responseSizeLimit is specified and the number of matching results is more than this limit, then an ErrorResponse is returned. Specifying searchCriteriaModeOr without any search criteria results in 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 Integer	responseSizeLimit
protected @Valid SearchCriteriaDn[]	searchCriteriaDn
protected @Valid SearchCriteriaExactUserDepartment	searchCriteriaExactUserDepartment
protected @Valid SearchCriteriaExtension[]	searchCriteriaExtension
protected @Valid SearchCriteriaImpId[]	searchCriteriaImpId
protected @AssertTrue Boolean	searchCriteriaModeOr
protected @Valid SearchCriteriaUserFirstName[]	searchCriteriaUserFirstName
protected @Valid SearchCriteriaUserId[]	searchCriteriaUserId
protected @Valid SearchCriteriaUserLastName[]	searchCriteriaUserLastName
protected @NotNull @Size(min=1,max=161) String	supervisorUserId
protected @NotNull @Valid CallCenter	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserCallCenterGetSupervisedAgentListRequest()
UserCallCenterGetSupervisedAgentListRequest(String supervisorUserId, CallCenter user)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
CallCenter	getCallCenter()
static CallCenter.UserCallCenterGetSupervisedAgentListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Integer	getResponseSizeLimit()
SearchCriteriaDn[]	getSearchCriteriaDn()
SearchCriteriaExactUserDepartment	getSearchCriteriaExactUserDepartment()
SearchCriteriaExtension[]	getSearchCriteriaExtension()
SearchCriteriaImpId[]	getSearchCriteriaImpId()
Boolean	getSearchCriteriaModeOr()
SearchCriteriaUserFirstName[]	getSearchCriteriaUserFirstName()
SearchCriteriaUserId[]	getSearchCriteriaUserId()
SearchCriteriaUserLastName[]	getSearchCriteriaUserLastName()
String	getSupervisorUserId()
boolean	searchCriteriaModeOrFlagExist()
CallCenter.UserCallCenterGetSupervisedAgentListRequest	setFlagSearchCriteriaModeOr()
CallCenter.UserCallCenterGetSupervisedAgentListRequest	setResponseSizeLimit(Integer responseSizeLimit)
CallCenter.UserCallCenterGetSupervisedAgentListRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
CallCenter.UserCallCenterGetSupervisedAgentListRequest	setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)
CallCenter.UserCallCenterGetSupervisedAgentListRequest	setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)
CallCenter.UserCallCenterGetSupervisedAgentListRequest	setSearchCriteriaImpId(SearchCriteriaImpId... searchCriteriaImpId)
CallCenter.UserCallCenterGetSupervisedAgentListRequest	setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)
CallCenter.UserCallCenterGetSupervisedAgentListRequest	setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)
CallCenter.UserCallCenterGetSupervisedAgentListRequest	setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)
CallCenter.UserCallCenterGetSupervisedAgentListRequest	setSupervisorUserId(String supervisorUserId)
CallCenter.UserCallCenterGetSupervisedAgentListRequest	setUser(CallCenter user)

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 Detail

supervisorUserId

@NotNull
@Size(min=1,
      max=161)
protected @NotNull @Size(min=1,max=161) String supervisorUserId

user

@NotNull
@Valid
protected transient @NotNull @Valid CallCenter user

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaModeOr

@AssertTrue
protected @AssertTrue Boolean searchCriteriaModeOr

searchCriteriaUserLastName

@Valid
protected @Valid SearchCriteriaUserLastName[] searchCriteriaUserLastName

searchCriteriaUserFirstName

@Valid
protected @Valid SearchCriteriaUserFirstName[] searchCriteriaUserFirstName

searchCriteriaDn

@Valid
protected @Valid SearchCriteriaDn[] searchCriteriaDn

searchCriteriaExtension

@Valid
protected @Valid SearchCriteriaExtension[] searchCriteriaExtension

searchCriteriaUserId

@Valid
protected @Valid SearchCriteriaUserId[] searchCriteriaUserId

searchCriteriaExactUserDepartment

@Valid
protected @Valid SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment

searchCriteriaImpId

@Valid
protected @Valid SearchCriteriaImpId[] searchCriteriaImpId

Constructor Detail

UserCallCenterGetSupervisedAgentListRequest

public UserCallCenterGetSupervisedAgentListRequest()

UserCallCenterGetSupervisedAgentListRequest

public UserCallCenterGetSupervisedAgentListRequest(String supervisorUserId,
                                                   CallCenter user)

Method Detail

setSupervisorUserId

public CallCenter.UserCallCenterGetSupervisedAgentListRequest setSupervisorUserId(String supervisorUserId)

getSupervisorUserId

public String getSupervisorUserId()

setUser

public CallCenter.UserCallCenterGetSupervisedAgentListRequest setUser(CallCenter user)

getCallCenter

public CallCenter getCallCenter()

setResponseSizeLimit

public CallCenter.UserCallCenterGetSupervisedAgentListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setFlagSearchCriteriaModeOr

public CallCenter.UserCallCenterGetSupervisedAgentListRequest setFlagSearchCriteriaModeOr()

searchCriteriaModeOrFlagExist

public boolean searchCriteriaModeOrFlagExist()

getSearchCriteriaModeOr

public Boolean getSearchCriteriaModeOr()

setSearchCriteriaUserLastName

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

getSearchCriteriaUserLastName

public SearchCriteriaUserLastName[] getSearchCriteriaUserLastName()

setSearchCriteriaUserFirstName

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

getSearchCriteriaUserFirstName

public SearchCriteriaUserFirstName[] getSearchCriteriaUserFirstName()

setSearchCriteriaDn

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

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaExtension

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

getSearchCriteriaExtension

public SearchCriteriaExtension[] getSearchCriteriaExtension()

setSearchCriteriaUserId

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

getSearchCriteriaUserId

public SearchCriteriaUserId[] getSearchCriteriaUserId()

setSearchCriteriaExactUserDepartment

public CallCenter.UserCallCenterGetSupervisedAgentListRequest setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)

getSearchCriteriaExactUserDepartment

public SearchCriteriaExactUserDepartment getSearchCriteriaExactUserDepartment()

setSearchCriteriaImpId

public CallCenter.UserCallCenterGetSupervisedAgentListRequest setSearchCriteriaImpId(SearchCriteriaImpId... searchCriteriaImpId)

getSearchCriteriaImpId

public SearchCriteriaImpId[] getSearchCriteriaImpId()

getEmptyObject

public static CallCenter.UserCallCenterGetSupervisedAgentListRequest 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.UserCallCenterGetSupervisedAgentListResponse>