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

Class UserPersonalAssistant.UserPersonalAssistantExclusionNumberAddRequest

java.lang.Object

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

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

Enclosing class:

UserPersonalAssistant

public static class UserPersonalAssistant.UserPersonalAssistantExclusionNumberAddRequest
extends Request<DefaultResponse>

Add a User Personal Assistant Exclusion Number. 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 @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
UserPersonalAssistantExclusionNumberAddRequest()
UserPersonalAssistantExclusionNumberAddRequest(BroadWorksUser user, String exclusionNumber)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
String	getDescription()
static UserPersonalAssistant.UserPersonalAssistantExclusionNumberAddRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getExclusionNumber()
UserPersonalAssistant.UserPersonalAssistantExclusionNumberAddRequest	setDescription(String description)
UserPersonalAssistant.UserPersonalAssistantExclusionNumberAddRequest	setExclusionNumber(String exclusionNumber)
UserPersonalAssistant.UserPersonalAssistantExclusionNumberAddRequest	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

exclusionNumber

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

description

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

Constructor Details

UserPersonalAssistantExclusionNumberAddRequest

public UserPersonalAssistantExclusionNumberAddRequest()

UserPersonalAssistantExclusionNumberAddRequest

public UserPersonalAssistantExclusionNumberAddRequest(BroadWorksUser user,
 String exclusionNumber)

Method Details

setUser

public UserPersonalAssistant.UserPersonalAssistantExclusionNumberAddRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setExclusionNumber

public UserPersonalAssistant.UserPersonalAssistantExclusionNumberAddRequest setExclusionNumber(String exclusionNumber)

getExclusionNumber

public String getExclusionNumber()

setDescription

public UserPersonalAssistant.UserPersonalAssistantExclusionNumberAddRequest setDescription(String description)

getDescription

public String getDescription()

getEmptyObject

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