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

Class GroupCallPark.GroupCallParkGetInstancePagedSortedRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<GroupCallPark.GroupCallParkGetInstancePagedSortedResponse>

co.ecg.alpaca.toolkit.generated.services.GroupCallPark.GroupCallParkGetInstancePagedSortedRequest

Enclosing class:

GroupCallPark

public static class GroupCallPark.GroupCallParkGetInstancePagedSortedRequest
extends Request<GroupCallPark.GroupCallParkGetInstancePagedSortedResponse>

Gets a Call Park group. 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. The sort order is based on the user order provided when creating or modifying the call park instance. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are logically ORed together. The response is either GroupCallParkGetInstancePagedSortedResponse 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 @NotNull @Size(min=1,max=80) String	name
protected @Valid ResponsePagingControl	responsePagingControl
protected @Valid SearchCriteriaDepartmentName[]	searchCriteriaDepartmentName
protected @Valid SearchCriteriaDn[]	searchCriteriaDn
protected @Valid SearchCriteriaEmailAddress[]	searchCriteriaEmailAddress
protected @Valid SearchCriteriaExtension[]	searchCriteriaExtension
protected @AssertTrue Boolean	searchCriteriaModeOr
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
GroupCallParkGetInstancePagedSortedRequest()
GroupCallParkGetInstancePagedSortedRequest(Group group, String name)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static GroupCallPark.GroupCallParkGetInstancePagedSortedRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Group	getGroup()
String	getName()
ResponsePagingControl	getResponsePagingControl()
SearchCriteriaDepartmentName[]	getSearchCriteriaDepartmentName()
SearchCriteriaDn[]	getSearchCriteriaDn()
SearchCriteriaEmailAddress[]	getSearchCriteriaEmailAddress()
SearchCriteriaExtension[]	getSearchCriteriaExtension()
Boolean	getSearchCriteriaModeOr()
SearchCriteriaUserFirstName[]	getSearchCriteriaUserFirstName()
SearchCriteriaUserId[]	getSearchCriteriaUserId()
SearchCriteriaUserLastName[]	getSearchCriteriaUserLastName()
boolean	searchCriteriaModeOrFlagExist()
GroupCallPark.GroupCallParkGetInstancePagedSortedRequest	setFlagSearchCriteriaModeOr()
GroupCallPark.GroupCallParkGetInstancePagedSortedRequest	setGroup(Group group)
GroupCallPark.GroupCallParkGetInstancePagedSortedRequest	setName(String name)
GroupCallPark.GroupCallParkGetInstancePagedSortedRequest	setResponsePagingControl(ResponsePagingControl responsePagingControl)
GroupCallPark.GroupCallParkGetInstancePagedSortedRequest	setSearchCriteriaDepartmentName(SearchCriteriaDepartmentName... searchCriteriaDepartmentName)
GroupCallPark.GroupCallParkGetInstancePagedSortedRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
GroupCallPark.GroupCallParkGetInstancePagedSortedRequest	setSearchCriteriaEmailAddress(SearchCriteriaEmailAddress... searchCriteriaEmailAddress)
GroupCallPark.GroupCallParkGetInstancePagedSortedRequest	setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)
GroupCallPark.GroupCallParkGetInstancePagedSortedRequest	setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)
GroupCallPark.GroupCallParkGetInstancePagedSortedRequest	setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)
GroupCallPark.GroupCallParkGetInstancePagedSortedRequest	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

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

responsePagingControl

@Valid
protected @Valid ResponsePagingControl responsePagingControl

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

searchCriteriaEmailAddress

@Valid
protected @Valid SearchCriteriaEmailAddress[] searchCriteriaEmailAddress

searchCriteriaModeOr

@AssertTrue
protected @AssertTrue Boolean searchCriteriaModeOr

Constructor Details

GroupCallParkGetInstancePagedSortedRequest

public GroupCallParkGetInstancePagedSortedRequest()

GroupCallParkGetInstancePagedSortedRequest

public GroupCallParkGetInstancePagedSortedRequest(Group group,
 String name)

Method Details

setGroup

public GroupCallPark.GroupCallParkGetInstancePagedSortedRequest setGroup(Group group)

getGroup

public Group getGroup()

setName

public GroupCallPark.GroupCallParkGetInstancePagedSortedRequest setName(String name)

getName

public String getName()

setResponsePagingControl

public GroupCallPark.GroupCallParkGetInstancePagedSortedRequest setResponsePagingControl(ResponsePagingControl responsePagingControl)

getResponsePagingControl

public ResponsePagingControl getResponsePagingControl()

setSearchCriteriaUserId

public GroupCallPark.GroupCallParkGetInstancePagedSortedRequest setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)

getSearchCriteriaUserId

public SearchCriteriaUserId[] getSearchCriteriaUserId()

setSearchCriteriaUserLastName

public GroupCallPark.GroupCallParkGetInstancePagedSortedRequest setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)

getSearchCriteriaUserLastName

public SearchCriteriaUserLastName[] getSearchCriteriaUserLastName()

setSearchCriteriaUserFirstName

public GroupCallPark.GroupCallParkGetInstancePagedSortedRequest setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)

getSearchCriteriaUserFirstName

public SearchCriteriaUserFirstName[] getSearchCriteriaUserFirstName()

setSearchCriteriaDn

public GroupCallPark.GroupCallParkGetInstancePagedSortedRequest setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaExtension

public GroupCallPark.GroupCallParkGetInstancePagedSortedRequest setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)

getSearchCriteriaExtension

public SearchCriteriaExtension[] getSearchCriteriaExtension()

setSearchCriteriaDepartmentName

public GroupCallPark.GroupCallParkGetInstancePagedSortedRequest setSearchCriteriaDepartmentName(SearchCriteriaDepartmentName... searchCriteriaDepartmentName)

getSearchCriteriaDepartmentName

public SearchCriteriaDepartmentName[] getSearchCriteriaDepartmentName()

setSearchCriteriaEmailAddress

public GroupCallPark.GroupCallParkGetInstancePagedSortedRequest setSearchCriteriaEmailAddress(SearchCriteriaEmailAddress... searchCriteriaEmailAddress)

getSearchCriteriaEmailAddress

public SearchCriteriaEmailAddress[] getSearchCriteriaEmailAddress()

setFlagSearchCriteriaModeOr

public GroupCallPark.GroupCallParkGetInstancePagedSortedRequest setFlagSearchCriteriaModeOr()

searchCriteriaModeOrFlagExist

public boolean searchCriteriaModeOrFlagExist()

getSearchCriteriaModeOr

public Boolean getSearchCriteriaModeOr()

getEmptyObject

public static GroupCallPark.GroupCallParkGetInstancePagedSortedRequest 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<GroupCallPark.GroupCallParkGetInstancePagedSortedResponse>