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

Class GroupCallPark.GroupCallParkModifyInstanceRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<DefaultResponse>

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

Enclosing class:

GroupCallPark

public static class GroupCallPark.GroupCallParkModifyInstanceRequest
extends Request<DefaultResponse>

Modifies a Call Park group. Replaces the entire list of users in the group. The users are in the list are in the order they will try to be parked on. The response is either SuccessResponse 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 @Size(min=1,max=80) String	newName
protected Optional<@Size(min=1,max=161) String>	recallAlternateUserId
protected CallParkRecallTo	recallTo
protected Optional<@Valid ReplacementUserIdList>	userIdList

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static GroupCallPark.GroupCallParkModifyInstanceRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Group	getGroup()
String	getName()
String	getNewName()
Optional<@Size(min=1,max=161) String>	getRecallAlternateUserId()
CallParkRecallTo	getRecallTo()
Optional<@Valid ReplacementUserIdList>	getUserIdList()
GroupCallPark.GroupCallParkModifyInstanceRequest	setGroup(Group group)
GroupCallPark.GroupCallParkModifyInstanceRequest	setName(String name)
GroupCallPark.GroupCallParkModifyInstanceRequest	setNewName(String newName)
GroupCallPark.GroupCallParkModifyInstanceRequest	setRecallAlternateUserId(String recallAlternateUserId)
GroupCallPark.GroupCallParkModifyInstanceRequest	setRecallTo(CallParkRecallTo recallTo)
GroupCallPark.GroupCallParkModifyInstanceRequest	setUserIdList(ReplacementUserIdList userIdList)
GroupCallPark.GroupCallParkModifyInstanceRequest	unsetRecallAlternateUserId()
GroupCallPark.GroupCallParkModifyInstanceRequest	unsetUserIdList()

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

newName

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

userIdList

protected Optional<@Valid ReplacementUserIdList> userIdList

recallAlternateUserId

protected Optional<@Size(min=1,max=161) String> recallAlternateUserId

recallTo

protected CallParkRecallTo recallTo

Constructor Details

GroupCallParkModifyInstanceRequest

public GroupCallParkModifyInstanceRequest()

GroupCallParkModifyInstanceRequest

public GroupCallParkModifyInstanceRequest(Group group,
 String name)

Method Details

setGroup

public GroupCallPark.GroupCallParkModifyInstanceRequest setGroup(Group group)

getGroup

public Group getGroup()

setName

public GroupCallPark.GroupCallParkModifyInstanceRequest setName(String name)

getName

public String getName()

setNewName

public GroupCallPark.GroupCallParkModifyInstanceRequest setNewName(String newName)

getNewName

public String getNewName()

unsetUserIdList

public GroupCallPark.GroupCallParkModifyInstanceRequest unsetUserIdList()

setUserIdList

public GroupCallPark.GroupCallParkModifyInstanceRequest setUserIdList(ReplacementUserIdList userIdList)

getUserIdList

public Optional<@Valid ReplacementUserIdList> getUserIdList()

unsetRecallAlternateUserId

public GroupCallPark.GroupCallParkModifyInstanceRequest unsetRecallAlternateUserId()

setRecallAlternateUserId

public GroupCallPark.GroupCallParkModifyInstanceRequest setRecallAlternateUserId(String recallAlternateUserId)

getRecallAlternateUserId

public Optional<@Size(min=1,max=161) String> getRecallAlternateUserId()

setRecallTo

public GroupCallPark.GroupCallParkModifyInstanceRequest setRecallTo(CallParkRecallTo recallTo)

getRecallTo

public CallParkRecallTo getRecallTo()

getEmptyObject

public static GroupCallPark.GroupCallParkModifyInstanceRequest 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<DefaultResponse>