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

Class UserPreAlertingAnnouncement.UserPreAlertingAnnouncementAddCriteriaRequest

java.lang.Object

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

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

Enclosing class:

UserPreAlertingAnnouncement

public static class UserPreAlertingAnnouncement.UserPreAlertingAnnouncementAddCriteriaRequest
extends Request<DefaultResponse>

Add a criteria to the user's pre-alerting 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 CriteriaFromDn	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
UserPreAlertingAnnouncementAddCriteriaRequest()
UserPreAlertingAnnouncementAddCriteriaRequest(BroadWorksUser user, String criteriaName, Boolean blacklisted, CriteriaFromDn 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 UserPreAlertingAnnouncement.UserPreAlertingAnnouncementAddCriteriaRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
CriteriaFromDn	getFromDnCriteria()
HolidaySchedule	getHolidaySchedule()
TimeSchedule	getTimeSchedule()
UserPreAlertingAnnouncement.UserPreAlertingAnnouncementAddCriteriaRequest	setBlacklisted(Boolean blacklisted)
UserPreAlertingAnnouncement.UserPreAlertingAnnouncementAddCriteriaRequest	setCallToNumber(CallToNumber... callToNumber)
UserPreAlertingAnnouncement.UserPreAlertingAnnouncementAddCriteriaRequest	setCriteriaName(String criteriaName)
UserPreAlertingAnnouncement.UserPreAlertingAnnouncementAddCriteriaRequest	setFromDnCriteria(CriteriaFromDn fromDnCriteria)
UserPreAlertingAnnouncement.UserPreAlertingAnnouncementAddCriteriaRequest	setHolidaySchedule(HolidaySchedule holidaySchedule)
UserPreAlertingAnnouncement.UserPreAlertingAnnouncementAddCriteriaRequest	setTimeSchedule(TimeSchedule timeSchedule)
UserPreAlertingAnnouncement.UserPreAlertingAnnouncementAddCriteriaRequest	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 CriteriaFromDn fromDnCriteria

callToNumber

@Valid
protected @Valid CallToNumber[] callToNumber

Constructor Details

UserPreAlertingAnnouncementAddCriteriaRequest

public UserPreAlertingAnnouncementAddCriteriaRequest()

UserPreAlertingAnnouncementAddCriteriaRequest

public UserPreAlertingAnnouncementAddCriteriaRequest(BroadWorksUser user,
 String criteriaName,
 Boolean blacklisted,
 CriteriaFromDn fromDnCriteria)

Method Details

setUser

public UserPreAlertingAnnouncement.UserPreAlertingAnnouncementAddCriteriaRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setCriteriaName

public UserPreAlertingAnnouncement.UserPreAlertingAnnouncementAddCriteriaRequest setCriteriaName(String criteriaName)

getCriteriaName

public String getCriteriaName()

setTimeSchedule

public UserPreAlertingAnnouncement.UserPreAlertingAnnouncementAddCriteriaRequest setTimeSchedule(TimeSchedule timeSchedule)

getTimeSchedule

public TimeSchedule getTimeSchedule()

setHolidaySchedule

public UserPreAlertingAnnouncement.UserPreAlertingAnnouncementAddCriteriaRequest setHolidaySchedule(HolidaySchedule holidaySchedule)

getHolidaySchedule

public HolidaySchedule getHolidaySchedule()

setBlacklisted

public UserPreAlertingAnnouncement.UserPreAlertingAnnouncementAddCriteriaRequest setBlacklisted(Boolean blacklisted)

getBlacklisted

public Boolean getBlacklisted()

setFromDnCriteria

public UserPreAlertingAnnouncement.UserPreAlertingAnnouncementAddCriteriaRequest setFromDnCriteria(CriteriaFromDn fromDnCriteria)

getFromDnCriteria

public CriteriaFromDn getFromDnCriteria()

setCallToNumber

public UserPreAlertingAnnouncement.UserPreAlertingAnnouncementAddCriteriaRequest setCallToNumber(CallToNumber... callToNumber)

getCallToNumber

public CallToNumber[] getCallToNumber()

getEmptyObject

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