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

Class UserPreAlertingAnnouncement.UserPreAlertingAnnouncementModifyCriteriaRequest

java.lang.Object

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

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

Enclosing class:

UserPreAlertingAnnouncement

public static class UserPreAlertingAnnouncement.UserPreAlertingAnnouncementModifyCriteriaRequest
extends Request<DefaultResponse>

Modify a criteria for the user's pre-alerting service. The following elements are only used in AS data mode: callToNumber For the callToNumbers in the callToNumberList, the extension element is not used and the number element is only used when the type is BroadWorks Mobility. 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 Boolean	blacklisted
protected Optional<@Valid ReplacementCallToNumberList>	callToNumberList
protected @NotNull @Size(min=1,max=50) String	criteriaName
protected @Valid CriteriaFromDnModify	fromDnCriteria
protected Optional<@Valid HolidaySchedule>	holidaySchedule
protected @Size(min=1,max=50) String	newCriteriaName
protected Optional<@Valid TimeSchedule>	timeSchedule
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
Boolean	getBlacklisted()
BroadWorksUser	getBroadWorksUser()
Optional<@Valid ReplacementCallToNumberList>	getCallToNumberList()
String	getCriteriaName()
static UserPreAlertingAnnouncement.UserPreAlertingAnnouncementModifyCriteriaRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
CriteriaFromDnModify	getFromDnCriteria()
Optional<@Valid HolidaySchedule>	getHolidaySchedule()
String	getNewCriteriaName()
Optional<@Valid TimeSchedule>	getTimeSchedule()
UserPreAlertingAnnouncement.UserPreAlertingAnnouncementModifyCriteriaRequest	setBlacklisted(Boolean blacklisted)
UserPreAlertingAnnouncement.UserPreAlertingAnnouncementModifyCriteriaRequest	setCallToNumberList(ReplacementCallToNumberList callToNumberList)
UserPreAlertingAnnouncement.UserPreAlertingAnnouncementModifyCriteriaRequest	setCriteriaName(String criteriaName)
UserPreAlertingAnnouncement.UserPreAlertingAnnouncementModifyCriteriaRequest	setFromDnCriteria(CriteriaFromDnModify fromDnCriteria)
UserPreAlertingAnnouncement.UserPreAlertingAnnouncementModifyCriteriaRequest	setHolidaySchedule(HolidaySchedule holidaySchedule)
UserPreAlertingAnnouncement.UserPreAlertingAnnouncementModifyCriteriaRequest	setNewCriteriaName(String newCriteriaName)
UserPreAlertingAnnouncement.UserPreAlertingAnnouncementModifyCriteriaRequest	setTimeSchedule(TimeSchedule timeSchedule)
UserPreAlertingAnnouncement.UserPreAlertingAnnouncementModifyCriteriaRequest	setUser(BroadWorksUser user)
UserPreAlertingAnnouncement.UserPreAlertingAnnouncementModifyCriteriaRequest	unsetCallToNumberList()
UserPreAlertingAnnouncement.UserPreAlertingAnnouncementModifyCriteriaRequest	unsetHolidaySchedule()
UserPreAlertingAnnouncement.UserPreAlertingAnnouncementModifyCriteriaRequest	unsetTimeSchedule()

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

newCriteriaName

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

timeSchedule

protected Optional<@Valid TimeSchedule> timeSchedule

holidaySchedule

protected Optional<@Valid HolidaySchedule> holidaySchedule

blacklisted

protected Boolean blacklisted

fromDnCriteria

@Valid
protected @Valid CriteriaFromDnModify fromDnCriteria

callToNumberList

protected Optional<@Valid ReplacementCallToNumberList> callToNumberList

Constructor Details

UserPreAlertingAnnouncementModifyCriteriaRequest

public UserPreAlertingAnnouncementModifyCriteriaRequest()

UserPreAlertingAnnouncementModifyCriteriaRequest

public UserPreAlertingAnnouncementModifyCriteriaRequest(BroadWorksUser user,
 String criteriaName)

Method Details

setUser

public UserPreAlertingAnnouncement.UserPreAlertingAnnouncementModifyCriteriaRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setCriteriaName

public UserPreAlertingAnnouncement.UserPreAlertingAnnouncementModifyCriteriaRequest setCriteriaName(String criteriaName)

getCriteriaName

public String getCriteriaName()

setNewCriteriaName

public UserPreAlertingAnnouncement.UserPreAlertingAnnouncementModifyCriteriaRequest setNewCriteriaName(String newCriteriaName)

getNewCriteriaName

public String getNewCriteriaName()

unsetTimeSchedule

public UserPreAlertingAnnouncement.UserPreAlertingAnnouncementModifyCriteriaRequest unsetTimeSchedule()

setTimeSchedule

public UserPreAlertingAnnouncement.UserPreAlertingAnnouncementModifyCriteriaRequest setTimeSchedule(TimeSchedule timeSchedule)

getTimeSchedule

public Optional<@Valid TimeSchedule> getTimeSchedule()

unsetHolidaySchedule

public UserPreAlertingAnnouncement.UserPreAlertingAnnouncementModifyCriteriaRequest unsetHolidaySchedule()

setHolidaySchedule

public UserPreAlertingAnnouncement.UserPreAlertingAnnouncementModifyCriteriaRequest setHolidaySchedule(HolidaySchedule holidaySchedule)

getHolidaySchedule

public Optional<@Valid HolidaySchedule> getHolidaySchedule()

setBlacklisted

public UserPreAlertingAnnouncement.UserPreAlertingAnnouncementModifyCriteriaRequest setBlacklisted(Boolean blacklisted)

getBlacklisted

public Boolean getBlacklisted()

setFromDnCriteria

public UserPreAlertingAnnouncement.UserPreAlertingAnnouncementModifyCriteriaRequest setFromDnCriteria(CriteriaFromDnModify fromDnCriteria)

getFromDnCriteria

public CriteriaFromDnModify getFromDnCriteria()

unsetCallToNumberList

public UserPreAlertingAnnouncement.UserPreAlertingAnnouncementModifyCriteriaRequest unsetCallToNumberList()

setCallToNumberList

public UserPreAlertingAnnouncement.UserPreAlertingAnnouncementModifyCriteriaRequest setCallToNumberList(ReplacementCallToNumberList callToNumberList)

getCallToNumberList

public Optional<@Valid ReplacementCallToNumberList> getCallToNumberList()

getEmptyObject

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