Package co.ecg.alpaca.toolkit.generated

Class User.UserModifyGroupIdRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<User.UserModifyGroupIdResponse>

co.ecg.alpaca.toolkit.generated.User.UserModifyGroupIdRequest

Enclosing class:

User

public static class User.UserModifyGroupIdRequest
extends Request<User.UserModifyGroupIdResponse>

Move the user from one group to another group within the same enterprise. If evaluateOnly is specified, no actual move will happen. The command only tests the move and reports the impacts or possible conditions preventing the move. The response is either UserModifyGroupIdResponse 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 @AssertTrue Boolean	evaluateOnly
protected @NotNull @Size(min=1,max=30) String	newGroupId
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserModifyGroupIdRequest()
UserModifyGroupIdRequest(BroadWorksUser user, String newGroupId)

Method Summary

Modifier and Type	Method	Description
boolean	evaluateOnlyFlagExist()
void	formRequest()	Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
static User.UserModifyGroupIdRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Boolean	getEvaluateOnly()
String	getNewGroupId()
User.UserModifyGroupIdRequest	setFlagEvaluateOnly()
User.UserModifyGroupIdRequest	setNewGroupId(String newGroupId)
User.UserModifyGroupIdRequest	setUser(BroadWorksUser user)

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

user

@NotNull
@Valid
protected transient @NotNull @Valid BroadWorksUser user

newGroupId

@NotNull
@Size(min=1,
      max=30)
protected @NotNull @Size(min=1,max=30) String newGroupId

evaluateOnly

@AssertTrue
protected @AssertTrue Boolean evaluateOnly

Constructor Details

UserModifyGroupIdRequest

public UserModifyGroupIdRequest()

UserModifyGroupIdRequest

public UserModifyGroupIdRequest(BroadWorksUser user,
 String newGroupId)

Method Details

setUser

public User.UserModifyGroupIdRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setNewGroupId

public User.UserModifyGroupIdRequest setNewGroupId(String newGroupId)

getNewGroupId

public String getNewGroupId()

setFlagEvaluateOnly

public User.UserModifyGroupIdRequest setFlagEvaluateOnly()

evaluateOnlyFlagExist

public boolean evaluateOnlyFlagExist()

getEvaluateOnly

public Boolean getEvaluateOnly()

getEmptyObject

public static User.UserModifyGroupIdRequest 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<User.UserModifyGroupIdResponse>