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

Class UserPriorityAlert.UserPriorityAlertAddCriteriaRequest

java.lang.Object

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

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

Enclosing class:

UserPriorityAlert

public static class UserPriorityAlert.UserPriorityAlertAddCriteriaRequest
extends Request<DefaultResponse>

Add a criteria to the user's priority alert service. The following elements are only used in AS data mode: callToNumber For the callToNumber, 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 @NotNull Boolean	blacklisted
protected @Valid CallToNumber[]	callToNumber
protected @NotNull @Size(min=1,max=50) String	criteriaName
protected @NotNull @Valid PriorityAlertCriteriaFromDn	fromDnCriteria
protected @Valid HolidaySchedule	holidaySchedule
protected @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
UserPriorityAlertAddCriteriaRequest()
UserPriorityAlertAddCriteriaRequest(BroadWorksUser user, String criteriaName, Boolean blacklisted, PriorityAlertCriteriaFromDn fromDnCriteria)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
Boolean	getBlacklisted()
BroadWorksUser	getBroadWorksUser()
CallToNumber[]	getCallToNumber()
String	getCriteriaName()
static UserPriorityAlert.UserPriorityAlertAddCriteriaRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
PriorityAlertCriteriaFromDn	getFromDnCriteria()
HolidaySchedule	getHolidaySchedule()
TimeSchedule	getTimeSchedule()
UserPriorityAlert.UserPriorityAlertAddCriteriaRequest	setBlacklisted(Boolean blacklisted)
UserPriorityAlert.UserPriorityAlertAddCriteriaRequest	setCallToNumber(CallToNumber... callToNumber)
UserPriorityAlert.UserPriorityAlertAddCriteriaRequest	setCriteriaName(String criteriaName)
UserPriorityAlert.UserPriorityAlertAddCriteriaRequest	setFromDnCriteria(PriorityAlertCriteriaFromDn fromDnCriteria)
UserPriorityAlert.UserPriorityAlertAddCriteriaRequest	setHolidaySchedule(HolidaySchedule holidaySchedule)
UserPriorityAlert.UserPriorityAlertAddCriteriaRequest	setTimeSchedule(TimeSchedule timeSchedule)
UserPriorityAlert.UserPriorityAlertAddCriteriaRequest	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

timeSchedule

@Valid
protected @Valid TimeSchedule timeSchedule

holidaySchedule

@Valid
protected @Valid HolidaySchedule holidaySchedule

blacklisted

@NotNull
protected @NotNull Boolean blacklisted

fromDnCriteria

@NotNull
@Valid
protected @NotNull @Valid PriorityAlertCriteriaFromDn fromDnCriteria

callToNumber

@Valid
protected @Valid CallToNumber[] callToNumber

Constructor Details

UserPriorityAlertAddCriteriaRequest

public UserPriorityAlertAddCriteriaRequest()

UserPriorityAlertAddCriteriaRequest

public UserPriorityAlertAddCriteriaRequest(BroadWorksUser user,
 String criteriaName,
 Boolean blacklisted,
 PriorityAlertCriteriaFromDn fromDnCriteria)

Method Details

setUser

public UserPriorityAlert.UserPriorityAlertAddCriteriaRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setCriteriaName

public UserPriorityAlert.UserPriorityAlertAddCriteriaRequest setCriteriaName(String criteriaName)

getCriteriaName

public String getCriteriaName()

setTimeSchedule

public UserPriorityAlert.UserPriorityAlertAddCriteriaRequest setTimeSchedule(TimeSchedule timeSchedule)

getTimeSchedule

public TimeSchedule getTimeSchedule()

setHolidaySchedule

public UserPriorityAlert.UserPriorityAlertAddCriteriaRequest setHolidaySchedule(HolidaySchedule holidaySchedule)

getHolidaySchedule

public HolidaySchedule getHolidaySchedule()

setBlacklisted

public UserPriorityAlert.UserPriorityAlertAddCriteriaRequest setBlacklisted(Boolean blacklisted)

getBlacklisted

public Boolean getBlacklisted()

setFromDnCriteria

public UserPriorityAlert.UserPriorityAlertAddCriteriaRequest setFromDnCriteria(PriorityAlertCriteriaFromDn fromDnCriteria)

getFromDnCriteria

public PriorityAlertCriteriaFromDn getFromDnCriteria()

setCallToNumber

public UserPriorityAlert.UserPriorityAlertAddCriteriaRequest setCallToNumber(CallToNumber... callToNumber)

getCallToNumber

public CallToNumber[] getCallToNumber()

getEmptyObject

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