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

Class GroupSeriesCompletion.GroupSeriesCompletionModifyInstanceRequest

java.lang.Object

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

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

Enclosing class:

GroupSeriesCompletion

public static class GroupSeriesCompletion.GroupSeriesCompletionModifyInstanceRequest
extends Request<DefaultResponse>

Modifies a Series Completion group. Replaces the entire list of users in the group. 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<@Valid ReplacementUserIdList>	userIdList

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static GroupSeriesCompletion.GroupSeriesCompletionModifyInstanceRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Group	getGroup()
String	getName()
String	getNewName()
Optional<@Valid ReplacementUserIdList>	getUserIdList()
GroupSeriesCompletion.GroupSeriesCompletionModifyInstanceRequest	setGroup(Group group)
GroupSeriesCompletion.GroupSeriesCompletionModifyInstanceRequest	setName(String name)
GroupSeriesCompletion.GroupSeriesCompletionModifyInstanceRequest	setNewName(String newName)
GroupSeriesCompletion.GroupSeriesCompletionModifyInstanceRequest	setUserIdList(ReplacementUserIdList userIdList)
GroupSeriesCompletion.GroupSeriesCompletionModifyInstanceRequest	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 Detail

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

Constructor Detail

GroupSeriesCompletionModifyInstanceRequest

public GroupSeriesCompletionModifyInstanceRequest()

GroupSeriesCompletionModifyInstanceRequest

public GroupSeriesCompletionModifyInstanceRequest(Group group,
                                                  String name)

Method Detail

setGroup

public GroupSeriesCompletion.GroupSeriesCompletionModifyInstanceRequest setGroup(Group group)

getGroup

public Group getGroup()

setName

public GroupSeriesCompletion.GroupSeriesCompletionModifyInstanceRequest setName(String name)

getName

public String getName()

setNewName

public GroupSeriesCompletion.GroupSeriesCompletionModifyInstanceRequest setNewName(String newName)

getNewName

public String getNewName()

unsetUserIdList

public GroupSeriesCompletion.GroupSeriesCompletionModifyInstanceRequest unsetUserIdList()

setUserIdList

public GroupSeriesCompletion.GroupSeriesCompletionModifyInstanceRequest setUserIdList(ReplacementUserIdList userIdList)

getUserIdList

public Optional<@Valid ReplacementUserIdList> getUserIdList()

getEmptyObject

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