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

Class GroupCallPickup.GroupCallPickupGetInstancePagedSortedRequest

java.lang.Object

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

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

Enclosing class:

GroupCallPickup

public static class GroupCallPickup.GroupCallPickupGetInstancePagedSortedRequest
extends Request<GroupCallPickup.GroupCallPickupGetInstancePagedSortedResponse>

Gets a Call Pickup 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. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are logically ORed together. If no sortOrder is included the response is sorted by User Id ascending by default. The response is either GroupCallPickupGetInstancePagedSortedResponse 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
protected @Valid @Size(max=3) SortOrderGroupCallPickupGetInstancePagedSorted[]	sortOrder

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

log

Constructor Summary

Constructors

Constructor	Description
GroupCallPickupGetInstancePagedSortedRequest()
GroupCallPickupGetInstancePagedSortedRequest(Group group, String name)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static GroupCallPickup.GroupCallPickupGetInstancePagedSortedRequest	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()
SortOrderGroupCallPickupGetInstancePagedSorted[]	getSortOrder()
boolean	searchCriteriaModeOrFlagExist()
GroupCallPickup.GroupCallPickupGetInstancePagedSortedRequest	setFlagSearchCriteriaModeOr()
GroupCallPickup.GroupCallPickupGetInstancePagedSortedRequest	setGroup(Group group)
GroupCallPickup.GroupCallPickupGetInstancePagedSortedRequest	setName(String name)
GroupCallPickup.GroupCallPickupGetInstancePagedSortedRequest	setResponsePagingControl(ResponsePagingControl responsePagingControl)
GroupCallPickup.GroupCallPickupGetInstancePagedSortedRequest	setSearchCriteriaDepartmentName(SearchCriteriaDepartmentName... searchCriteriaDepartmentName)
GroupCallPickup.GroupCallPickupGetInstancePagedSortedRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
GroupCallPickup.GroupCallPickupGetInstancePagedSortedRequest	setSearchCriteriaEmailAddress(SearchCriteriaEmailAddress... searchCriteriaEmailAddress)
GroupCallPickup.GroupCallPickupGetInstancePagedSortedRequest	setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)
GroupCallPickup.GroupCallPickupGetInstancePagedSortedRequest	setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)
GroupCallPickup.GroupCallPickupGetInstancePagedSortedRequest	setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)
GroupCallPickup.GroupCallPickupGetInstancePagedSortedRequest	setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)
GroupCallPickup.GroupCallPickupGetInstancePagedSortedRequest	setSortOrder(SortOrderGroupCallPickupGetInstancePagedSorted... 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, 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

sortOrder

@Valid
@Size(max=3)
protected @Valid @Size(max=3) SortOrderGroupCallPickupGetInstancePagedSorted[] 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

searchCriteriaEmailAddress

@Valid
protected @Valid SearchCriteriaEmailAddress[] searchCriteriaEmailAddress

searchCriteriaModeOr

@AssertTrue
protected @AssertTrue Boolean searchCriteriaModeOr

Constructor Details

GroupCallPickupGetInstancePagedSortedRequest

public GroupCallPickupGetInstancePagedSortedRequest()

GroupCallPickupGetInstancePagedSortedRequest

public GroupCallPickupGetInstancePagedSortedRequest(Group group,
 String name)

Method Details

setGroup

public GroupCallPickup.GroupCallPickupGetInstancePagedSortedRequest setGroup(Group group)

getGroup

public Group getGroup()

setName

public GroupCallPickup.GroupCallPickupGetInstancePagedSortedRequest setName(String name)

getName

public String getName()

setResponsePagingControl

public GroupCallPickup.GroupCallPickupGetInstancePagedSortedRequest setResponsePagingControl(ResponsePagingControl responsePagingControl)

getResponsePagingControl

public ResponsePagingControl getResponsePagingControl()

setSortOrder

public GroupCallPickup.GroupCallPickupGetInstancePagedSortedRequest setSortOrder(SortOrderGroupCallPickupGetInstancePagedSorted... sortOrder)

getSortOrder

public SortOrderGroupCallPickupGetInstancePagedSorted[] getSortOrder()

setSearchCriteriaUserId

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

getSearchCriteriaUserId

public SearchCriteriaUserId[] getSearchCriteriaUserId()

setSearchCriteriaUserLastName

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

getSearchCriteriaUserLastName

public SearchCriteriaUserLastName[] getSearchCriteriaUserLastName()

setSearchCriteriaUserFirstName

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

getSearchCriteriaUserFirstName

public SearchCriteriaUserFirstName[] getSearchCriteriaUserFirstName()

setSearchCriteriaDn

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

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaExtension

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

getSearchCriteriaExtension

public SearchCriteriaExtension[] getSearchCriteriaExtension()

setSearchCriteriaDepartmentName

public GroupCallPickup.GroupCallPickupGetInstancePagedSortedRequest setSearchCriteriaDepartmentName(SearchCriteriaDepartmentName... searchCriteriaDepartmentName)

getSearchCriteriaDepartmentName

public SearchCriteriaDepartmentName[] getSearchCriteriaDepartmentName()

setSearchCriteriaEmailAddress

public GroupCallPickup.GroupCallPickupGetInstancePagedSortedRequest setSearchCriteriaEmailAddress(SearchCriteriaEmailAddress... searchCriteriaEmailAddress)

getSearchCriteriaEmailAddress

public SearchCriteriaEmailAddress[] getSearchCriteriaEmailAddress()

setFlagSearchCriteriaModeOr

public GroupCallPickup.GroupCallPickupGetInstancePagedSortedRequest setFlagSearchCriteriaModeOr()

searchCriteriaModeOrFlagExist

public boolean searchCriteriaModeOrFlagExist()

getSearchCriteriaModeOr

public Boolean getSearchCriteriaModeOr()

getEmptyObject

public static GroupCallPickup.GroupCallPickupGetInstancePagedSortedRequest 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.GroupCallPickupGetInstancePagedSortedResponse>