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

Class UserPriorityAlert.UserPriorityAlertModifyCriteriaRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.services.UserPriorityAlert.UserPriorityAlertModifyCriteriaRequest

Enclosing class:

UserPriorityAlert

public static class UserPriorityAlert.UserPriorityAlertModifyCriteriaRequest
extends Request<DefaultResponse>

Modify a criteria for the user's priority alert service. The following elements are only used in AS data mode: callToNumberList 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 PriorityAlertCriteriaFromDnModify	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
UserPriorityAlertModifyCriteriaRequest()
UserPriorityAlertModifyCriteriaRequest(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 UserPriorityAlert.UserPriorityAlertModifyCriteriaRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
PriorityAlertCriteriaFromDnModify	getFromDnCriteria()
Optional<@Valid HolidaySchedule>	getHolidaySchedule()
String	getNewCriteriaName()
Optional<@Valid TimeSchedule>	getTimeSchedule()
UserPriorityAlert.UserPriorityAlertModifyCriteriaRequest	setBlacklisted(Boolean blacklisted)
UserPriorityAlert.UserPriorityAlertModifyCriteriaRequest	setCallToNumberList(ReplacementCallToNumberList callToNumberList)
UserPriorityAlert.UserPriorityAlertModifyCriteriaRequest	setCriteriaName(String criteriaName)
UserPriorityAlert.UserPriorityAlertModifyCriteriaRequest	setFromDnCriteria(PriorityAlertCriteriaFromDnModify fromDnCriteria)
UserPriorityAlert.UserPriorityAlertModifyCriteriaRequest	setHolidaySchedule(HolidaySchedule holidaySchedule)
UserPriorityAlert.UserPriorityAlertModifyCriteriaRequest	setNewCriteriaName(String newCriteriaName)
UserPriorityAlert.UserPriorityAlertModifyCriteriaRequest	setTimeSchedule(TimeSchedule timeSchedule)
UserPriorityAlert.UserPriorityAlertModifyCriteriaRequest	setUser(BroadWorksUser user)
UserPriorityAlert.UserPriorityAlertModifyCriteriaRequest	unsetCallToNumberList()
UserPriorityAlert.UserPriorityAlertModifyCriteriaRequest	unsetHolidaySchedule()
UserPriorityAlert.UserPriorityAlertModifyCriteriaRequest	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

fromDnCriteria

@Valid
protected @Valid PriorityAlertCriteriaFromDnModify fromDnCriteria

holidaySchedule

protected Optional<@Valid HolidaySchedule> holidaySchedule

blacklisted

protected Boolean blacklisted

callToNumberList

protected Optional<@Valid ReplacementCallToNumberList> callToNumberList

Constructor Details

UserPriorityAlertModifyCriteriaRequest

public UserPriorityAlertModifyCriteriaRequest()

UserPriorityAlertModifyCriteriaRequest

public UserPriorityAlertModifyCriteriaRequest(BroadWorksUser user,
 String criteriaName)

Method Details

setUser

public UserPriorityAlert.UserPriorityAlertModifyCriteriaRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setCriteriaName

public UserPriorityAlert.UserPriorityAlertModifyCriteriaRequest setCriteriaName(String criteriaName)

getCriteriaName

public String getCriteriaName()

setNewCriteriaName

public UserPriorityAlert.UserPriorityAlertModifyCriteriaRequest setNewCriteriaName(String newCriteriaName)

getNewCriteriaName

public String getNewCriteriaName()

unsetTimeSchedule

public UserPriorityAlert.UserPriorityAlertModifyCriteriaRequest unsetTimeSchedule()

setTimeSchedule

public UserPriorityAlert.UserPriorityAlertModifyCriteriaRequest setTimeSchedule(TimeSchedule timeSchedule)

getTimeSchedule

public Optional<@Valid TimeSchedule> getTimeSchedule()

setFromDnCriteria

public UserPriorityAlert.UserPriorityAlertModifyCriteriaRequest setFromDnCriteria(PriorityAlertCriteriaFromDnModify fromDnCriteria)

getFromDnCriteria

public PriorityAlertCriteriaFromDnModify getFromDnCriteria()

unsetHolidaySchedule

public UserPriorityAlert.UserPriorityAlertModifyCriteriaRequest unsetHolidaySchedule()

setHolidaySchedule

public UserPriorityAlert.UserPriorityAlertModifyCriteriaRequest setHolidaySchedule(HolidaySchedule holidaySchedule)

getHolidaySchedule

public Optional<@Valid HolidaySchedule> getHolidaySchedule()

setBlacklisted

public UserPriorityAlert.UserPriorityAlertModifyCriteriaRequest setBlacklisted(Boolean blacklisted)

getBlacklisted

public Boolean getBlacklisted()

unsetCallToNumberList

public UserPriorityAlert.UserPriorityAlertModifyCriteriaRequest unsetCallToNumberList()

setCallToNumberList

public UserPriorityAlert.UserPriorityAlertModifyCriteriaRequest setCallToNumberList(ReplacementCallToNumberList callToNumberList)

getCallToNumberList

public Optional<@Valid ReplacementCallToNumberList> getCallToNumberList()

getEmptyObject

public static UserPriorityAlert.UserPriorityAlertModifyCriteriaRequest 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>