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

Class UserPreAlertingAnnouncement.UserPreAlertingAnnouncementGetCriteriaRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<UserPreAlertingAnnouncement.UserPreAlertingAnnouncementGetCriteriaResponse>

co.ecg.alpaca.toolkit.generated.services.UserPreAlertingAnnouncement.UserPreAlertingAnnouncementGetCriteriaRequest

Enclosing class:

UserPreAlertingAnnouncement

public static class UserPreAlertingAnnouncement.UserPreAlertingAnnouncementGetCriteriaRequest
extends Request<UserPreAlertingAnnouncement.UserPreAlertingAnnouncementGetCriteriaResponse>

Get a criteria for the user's pre-alerting service. The response is either a UserPreAlertingAnnouncementGetCriteriaResponseRI 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 @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserPreAlertingAnnouncementGetCriteriaRequest()
UserPreAlertingAnnouncementGetCriteriaRequest(BroadWorksUser user, String criteriaName)

Method Summary

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

criteriaName

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

Constructor Details

UserPreAlertingAnnouncementGetCriteriaRequest

public UserPreAlertingAnnouncementGetCriteriaRequest()

UserPreAlertingAnnouncementGetCriteriaRequest

public UserPreAlertingAnnouncementGetCriteriaRequest(BroadWorksUser user,
 String criteriaName)

Method Details

setUser

public UserPreAlertingAnnouncement.UserPreAlertingAnnouncementGetCriteriaRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setCriteriaName

public UserPreAlertingAnnouncement.UserPreAlertingAnnouncementGetCriteriaRequest setCriteriaName(String criteriaName)

getCriteriaName

public String getCriteriaName()

getEmptyObject

public static UserPreAlertingAnnouncement.UserPreAlertingAnnouncementGetCriteriaRequest 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<UserPreAlertingAnnouncement.UserPreAlertingAnnouncementGetCriteriaResponse>