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

Class UserPersonalAssistant.UserPersonalAssistantExclusionNumberModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.services.UserPersonalAssistant.UserPersonalAssistantExclusionNumberModifyRequest

Enclosing class:

UserPersonalAssistant

public static class UserPersonalAssistant.UserPersonalAssistantExclusionNumberModifyRequest
extends Request<DefaultResponse>

Modify an existing User Personal Assistant Exclusion Number description. The response is either a SuccessResponse or an 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 Optional<@Size(min=1,max=80) String>	description
protected @NotNull @Size(min=1,max=23) String	exclusionNumber
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserPersonalAssistantExclusionNumberModifyRequest()
UserPersonalAssistantExclusionNumberModifyRequest(BroadWorksUser user, String exclusionNumber)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
Optional<@Size(min=1,max=80) String>	getDescription()
static UserPersonalAssistant.UserPersonalAssistantExclusionNumberModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getExclusionNumber()
UserPersonalAssistant.UserPersonalAssistantExclusionNumberModifyRequest	setDescription(String description)
UserPersonalAssistant.UserPersonalAssistantExclusionNumberModifyRequest	setExclusionNumber(String exclusionNumber)
UserPersonalAssistant.UserPersonalAssistantExclusionNumberModifyRequest	setUser(BroadWorksUser user)
UserPersonalAssistant.UserPersonalAssistantExclusionNumberModifyRequest	unsetDescription()

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

exclusionNumber

@NotNull
@Size(min=1,
      max=23)
protected @NotNull @Size(min=1,max=23) String exclusionNumber

description

protected Optional<@Size(min=1,max=80) String> description

Constructor Details

UserPersonalAssistantExclusionNumberModifyRequest

public UserPersonalAssistantExclusionNumberModifyRequest()

UserPersonalAssistantExclusionNumberModifyRequest

public UserPersonalAssistantExclusionNumberModifyRequest(BroadWorksUser user,
 String exclusionNumber)

Method Details

setUser

public UserPersonalAssistant.UserPersonalAssistantExclusionNumberModifyRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setExclusionNumber

public UserPersonalAssistant.UserPersonalAssistantExclusionNumberModifyRequest setExclusionNumber(String exclusionNumber)

getExclusionNumber

public String getExclusionNumber()

unsetDescription

public UserPersonalAssistant.UserPersonalAssistantExclusionNumberModifyRequest unsetDescription()

setDescription

public UserPersonalAssistant.UserPersonalAssistantExclusionNumberModifyRequest setDescription(String description)

getDescription

public Optional<@Size(min=1,max=80) String> getDescription()

getEmptyObject

public static UserPersonalAssistant.UserPersonalAssistantExclusionNumberModifyRequest 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>