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

Class GroupSeriesCompletion.GroupSeriesCompletionGetAvailableUserListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<GroupSeriesCompletion.GroupSeriesCompletionGetAvailableUserListResponse>

co.ecg.alpaca.toolkit.generated.services.GroupSeriesCompletion.GroupSeriesCompletionGetAvailableUserListRequest

Enclosing class:

GroupSeriesCompletion

public static class GroupSeriesCompletion.GroupSeriesCompletionGetAvailableUserListRequest
extends Request<GroupSeriesCompletion.GroupSeriesCompletionGetAvailableUserListResponse>

Get a list of users that can be assigned to a Series Completion group. The available user list for a new Series Completion group can be obtained by not setting the name. The response is either GroupSeriesCompletionGetAvailableUserListResponse 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
GroupSeriesCompletionGetAvailableUserListRequest()
GroupSeriesCompletionGetAvailableUserListRequest(Group group)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static GroupSeriesCompletion.GroupSeriesCompletionGetAvailableUserListRequest	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()
GroupSeriesCompletion.GroupSeriesCompletionGetAvailableUserListRequest	setGroup(Group group)
GroupSeriesCompletion.GroupSeriesCompletionGetAvailableUserListRequest	setName(String name)
GroupSeriesCompletion.GroupSeriesCompletionGetAvailableUserListRequest	setResponseSizeLimit(Integer responseSizeLimit)
GroupSeriesCompletion.GroupSeriesCompletionGetAvailableUserListRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
GroupSeriesCompletion.GroupSeriesCompletionGetAvailableUserListRequest	setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)
GroupSeriesCompletion.GroupSeriesCompletionGetAvailableUserListRequest	setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)
GroupSeriesCompletion.GroupSeriesCompletionGetAvailableUserListRequest	setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)
GroupSeriesCompletion.GroupSeriesCompletionGetAvailableUserListRequest	setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)
GroupSeriesCompletion.GroupSeriesCompletionGetAvailableUserListRequest	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

GroupSeriesCompletionGetAvailableUserListRequest

public GroupSeriesCompletionGetAvailableUserListRequest()

GroupSeriesCompletionGetAvailableUserListRequest

public GroupSeriesCompletionGetAvailableUserListRequest(Group group)

Method Details

setGroup

public GroupSeriesCompletion.GroupSeriesCompletionGetAvailableUserListRequest setGroup(Group group)

getGroup

public Group getGroup()

setName

public GroupSeriesCompletion.GroupSeriesCompletionGetAvailableUserListRequest setName(String name)

getName

public String getName()

setResponseSizeLimit

public GroupSeriesCompletion.GroupSeriesCompletionGetAvailableUserListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaUserLastName

public GroupSeriesCompletion.GroupSeriesCompletionGetAvailableUserListRequest setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)

getSearchCriteriaUserLastName

public SearchCriteriaUserLastName[] getSearchCriteriaUserLastName()

setSearchCriteriaUserFirstName

public GroupSeriesCompletion.GroupSeriesCompletionGetAvailableUserListRequest setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)

getSearchCriteriaUserFirstName

public SearchCriteriaUserFirstName[] getSearchCriteriaUserFirstName()

setSearchCriteriaExactUserDepartment

public GroupSeriesCompletion.GroupSeriesCompletionGetAvailableUserListRequest setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)

getSearchCriteriaExactUserDepartment

public SearchCriteriaExactUserDepartment getSearchCriteriaExactUserDepartment()

setSearchCriteriaUserId

public GroupSeriesCompletion.GroupSeriesCompletionGetAvailableUserListRequest setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)

getSearchCriteriaUserId

public SearchCriteriaUserId[] getSearchCriteriaUserId()

setSearchCriteriaDn

public GroupSeriesCompletion.GroupSeriesCompletionGetAvailableUserListRequest setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaExtension

public GroupSeriesCompletion.GroupSeriesCompletionGetAvailableUserListRequest setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)

getSearchCriteriaExtension

public SearchCriteriaExtension[] getSearchCriteriaExtension()

getEmptyObject

public static GroupSeriesCompletion.GroupSeriesCompletionGetAvailableUserListRequest 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<GroupSeriesCompletion.GroupSeriesCompletionGetAvailableUserListResponse>