Package co.ecg.alpaca.toolkit.generated.services

Class GroupCallPickup.GroupCallPickupGetAvailableUserListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<GroupCallPickup.GroupCallPickupGetAvailableUserListResponse>

co.ecg.alpaca.toolkit.generated.services.GroupCallPickup.GroupCallPickupGetAvailableUserListRequest

Enclosing class:

GroupCallPickup

public static class GroupCallPickup.GroupCallPickupGetAvailableUserListRequest
extends Request<GroupCallPickup.GroupCallPickupGetAvailableUserListResponse>

Get a list of users that can be assigned to a Call Pickup group. The available user list for a new Call Pickup group can be obtained by not setting the name. The response is either GroupCallPickupGetAvailableUserListResponse or 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 Group	group
protected @Size(min=1,max=80) String	name
protected Integer	responseSizeLimit
protected @Valid SearchCriteriaDn[]	searchCriteriaDn
protected @Valid SearchCriteriaExactUserDepartment	searchCriteriaExactUserDepartment
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
GroupCallPickupGetAvailableUserListRequest()
GroupCallPickupGetAvailableUserListRequest(Group group)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static GroupCallPickup.GroupCallPickupGetAvailableUserListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Group	getGroup()
String	getName()
Integer	getResponseSizeLimit()
SearchCriteriaDn[]	getSearchCriteriaDn()
SearchCriteriaExactUserDepartment	getSearchCriteriaExactUserDepartment()
SearchCriteriaExtension[]	getSearchCriteriaExtension()
SearchCriteriaUserFirstName[]	getSearchCriteriaUserFirstName()
SearchCriteriaUserId[]	getSearchCriteriaUserId()
SearchCriteriaUserLastName[]	getSearchCriteriaUserLastName()
GroupCallPickup.GroupCallPickupGetAvailableUserListRequest	setGroup(Group group)
GroupCallPickup.GroupCallPickupGetAvailableUserListRequest	setName(String name)
GroupCallPickup.GroupCallPickupGetAvailableUserListRequest	setResponseSizeLimit(Integer responseSizeLimit)
GroupCallPickup.GroupCallPickupGetAvailableUserListRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
GroupCallPickup.GroupCallPickupGetAvailableUserListRequest	setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)
GroupCallPickup.GroupCallPickupGetAvailableUserListRequest	setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)
GroupCallPickup.GroupCallPickupGetAvailableUserListRequest	setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)
GroupCallPickup.GroupCallPickupGetAvailableUserListRequest	setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)
GroupCallPickup.GroupCallPickupGetAvailableUserListRequest	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

group

@NotNull
@Valid
protected transient @NotNull @Valid Group group

name

@Size(min=1,
      max=80)
protected @Size(min=1,max=80) String name

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaUserLastName

@Valid
protected @Valid SearchCriteriaUserLastName[] searchCriteriaUserLastName

searchCriteriaUserFirstName

@Valid
protected @Valid SearchCriteriaUserFirstName[] searchCriteriaUserFirstName

searchCriteriaExactUserDepartment

@Valid
protected @Valid SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment

searchCriteriaUserId

@Valid
protected @Valid SearchCriteriaUserId[] searchCriteriaUserId

searchCriteriaDn

@Valid
protected @Valid SearchCriteriaDn[] searchCriteriaDn

searchCriteriaExtension

@Valid
protected @Valid SearchCriteriaExtension[] searchCriteriaExtension

Constructor Details

GroupCallPickupGetAvailableUserListRequest

public GroupCallPickupGetAvailableUserListRequest()

GroupCallPickupGetAvailableUserListRequest

public GroupCallPickupGetAvailableUserListRequest(Group group)

Method Details

setGroup

public GroupCallPickup.GroupCallPickupGetAvailableUserListRequest setGroup(Group group)

getGroup

public Group getGroup()

setName

public GroupCallPickup.GroupCallPickupGetAvailableUserListRequest setName(String name)

getName

public String getName()

setResponseSizeLimit

public GroupCallPickup.GroupCallPickupGetAvailableUserListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaUserLastName

public GroupCallPickup.GroupCallPickupGetAvailableUserListRequest setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)

getSearchCriteriaUserLastName

public SearchCriteriaUserLastName[] getSearchCriteriaUserLastName()

setSearchCriteriaUserFirstName

public GroupCallPickup.GroupCallPickupGetAvailableUserListRequest setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)

getSearchCriteriaUserFirstName

public SearchCriteriaUserFirstName[] getSearchCriteriaUserFirstName()

setSearchCriteriaExactUserDepartment

public GroupCallPickup.GroupCallPickupGetAvailableUserListRequest setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)

getSearchCriteriaExactUserDepartment

public SearchCriteriaExactUserDepartment getSearchCriteriaExactUserDepartment()

setSearchCriteriaUserId

public GroupCallPickup.GroupCallPickupGetAvailableUserListRequest setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)

getSearchCriteriaUserId

public SearchCriteriaUserId[] getSearchCriteriaUserId()

setSearchCriteriaDn

public GroupCallPickup.GroupCallPickupGetAvailableUserListRequest setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaExtension

public GroupCallPickup.GroupCallPickupGetAvailableUserListRequest setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)

getSearchCriteriaExtension

public SearchCriteriaExtension[] getSearchCriteriaExtension()

getEmptyObject

public static GroupCallPickup.GroupCallPickupGetAvailableUserListRequest 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<GroupCallPickup.GroupCallPickupGetAvailableUserListResponse>