Package co.ecg.alpaca.toolkit.generated

Class BroadWorksAnywherePortal.UserBroadWorksAnywhereGetSelectiveCriteriaRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<BroadWorksAnywherePortal.UserBroadWorksAnywhereGetSelectiveCriteriaResponse>

co.ecg.alpaca.toolkit.generated.BroadWorksAnywherePortal.UserBroadWorksAnywhereGetSelectiveCriteriaRequest

Enclosing class:

BroadWorksAnywherePortal

public static class BroadWorksAnywherePortal.UserBroadWorksAnywhereGetSelectiveCriteriaRequest
extends Request<BroadWorksAnywherePortal.UserBroadWorksAnywhereGetSelectiveCriteriaResponse>

Get a criteria for the user's BroadWorks Anywhere phone number. The response is either a UserBroadWorksAnywhereGetSelectiveCriteriaResponse21 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 @NotNull @Size(min=1,max=50) String	criteriaName
protected @NotNull @Size(min=1,max=23) String	phoneNumber
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserBroadWorksAnywhereGetSelectiveCriteriaRequest()
UserBroadWorksAnywhereGetSelectiveCriteriaRequest(BroadWorksUser user, String phoneNumber, String criteriaName)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
String	getCriteriaName()
static BroadWorksAnywherePortal.UserBroadWorksAnywhereGetSelectiveCriteriaRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getPhoneNumber()
BroadWorksAnywherePortal.UserBroadWorksAnywhereGetSelectiveCriteriaRequest	setCriteriaName(String criteriaName)
BroadWorksAnywherePortal.UserBroadWorksAnywhereGetSelectiveCriteriaRequest	setPhoneNumber(String phoneNumber)
BroadWorksAnywherePortal.UserBroadWorksAnywhereGetSelectiveCriteriaRequest	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

phoneNumber

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

criteriaName

@NotNull
@Size(min=1,
      max=50)
protected @NotNull @Size(min=1,max=50) String criteriaName

Constructor Details

UserBroadWorksAnywhereGetSelectiveCriteriaRequest

public UserBroadWorksAnywhereGetSelectiveCriteriaRequest()

UserBroadWorksAnywhereGetSelectiveCriteriaRequest

public UserBroadWorksAnywhereGetSelectiveCriteriaRequest(BroadWorksUser user,
 String phoneNumber,
 String criteriaName)

Method Details

setUser

public BroadWorksAnywherePortal.UserBroadWorksAnywhereGetSelectiveCriteriaRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setPhoneNumber

public BroadWorksAnywherePortal.UserBroadWorksAnywhereGetSelectiveCriteriaRequest setPhoneNumber(String phoneNumber)

getPhoneNumber

public String getPhoneNumber()

setCriteriaName

public BroadWorksAnywherePortal.UserBroadWorksAnywhereGetSelectiveCriteriaRequest setCriteriaName(String criteriaName)

getCriteriaName

public String getCriteriaName()

getEmptyObject

public static BroadWorksAnywherePortal.UserBroadWorksAnywhereGetSelectiveCriteriaRequest 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<BroadWorksAnywherePortal.UserBroadWorksAnywhereGetSelectiveCriteriaResponse>