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

Class UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.services.UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest

Enclosing class:

UserCustomRingback

public static class UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest
extends Request<DefaultResponse>

Modify a criteria for the user's custom ringback service. 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 @Valid ExtendedMediaFileLevelResource20	audioFile
protected ExtendedFileResourceSelection	audioSelection
protected Boolean	blacklisted
protected Optional<@Valid ReplacementCallToNumberList>	callToNumberList
protected @Valid ExtendedMediaFileLevelResource20	callWaitingAudioFile
protected ExtendedFileResourceSelection	callWaitingAudioSelection
protected @Valid ExtendedMediaFileLevelResource20	callWaitingVideoFile
protected ExtendedFileResourceSelection	callWaitingVideoSelection
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
protected @Valid ExtendedMediaFileLevelResource20	videoFile
protected ExtendedFileResourceSelection	videoSelection

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
ExtendedMediaFileLevelResource20	getAudioFile()
ExtendedFileResourceSelection	getAudioSelection()
Boolean	getBlacklisted()
BroadWorksUser	getBroadWorksUser()
Optional<@Valid ReplacementCallToNumberList>	getCallToNumberList()
ExtendedMediaFileLevelResource20	getCallWaitingAudioFile()
ExtendedFileResourceSelection	getCallWaitingAudioSelection()
ExtendedMediaFileLevelResource20	getCallWaitingVideoFile()
ExtendedFileResourceSelection	getCallWaitingVideoSelection()
String	getCriteriaName()
static UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
CriteriaFromDnModify	getFromDnCriteria()
Optional<@Valid HolidaySchedule>	getHolidaySchedule()
String	getNewCriteriaName()
Optional<@Valid TimeSchedule>	getTimeSchedule()
ExtendedMediaFileLevelResource20	getVideoFile()
ExtendedFileResourceSelection	getVideoSelection()
UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest	setAudioFile(ExtendedMediaFileLevelResource20 audioFile)
UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest	setAudioSelection(ExtendedFileResourceSelection audioSelection)
UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest	setBlacklisted(Boolean blacklisted)
UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest	setCallToNumberList(ReplacementCallToNumberList callToNumberList)
UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest	setCallWaitingAudioFile(ExtendedMediaFileLevelResource20 callWaitingAudioFile)
UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest	setCallWaitingAudioSelection(ExtendedFileResourceSelection callWaitingAudioSelection)
UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest	setCallWaitingVideoFile(ExtendedMediaFileLevelResource20 callWaitingVideoFile)
UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest	setCallWaitingVideoSelection(ExtendedFileResourceSelection callWaitingVideoSelection)
UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest	setCriteriaName(String criteriaName)
UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest	setFromDnCriteria(CriteriaFromDnModify fromDnCriteria)
UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest	setHolidaySchedule(HolidaySchedule holidaySchedule)
UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest	setNewCriteriaName(String newCriteriaName)
UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest	setTimeSchedule(TimeSchedule timeSchedule)
UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest	setUser(BroadWorksUser user)
UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest	setVideoFile(ExtendedMediaFileLevelResource20 videoFile)
UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest	setVideoSelection(ExtendedFileResourceSelection videoSelection)
UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest	unsetCallToNumberList()
UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest	unsetHolidaySchedule()
UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest	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, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setEcho, 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 Detail

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

audioSelection

protected ExtendedFileResourceSelection audioSelection

audioFile

@Valid
protected @Valid ExtendedMediaFileLevelResource20 audioFile

videoSelection

protected ExtendedFileResourceSelection videoSelection

videoFile

@Valid
protected @Valid ExtendedMediaFileLevelResource20 videoFile

callWaitingAudioSelection

protected ExtendedFileResourceSelection callWaitingAudioSelection

callWaitingAudioFile

@Valid
protected @Valid ExtendedMediaFileLevelResource20 callWaitingAudioFile

callWaitingVideoSelection

protected ExtendedFileResourceSelection callWaitingVideoSelection

callWaitingVideoFile

@Valid
protected @Valid ExtendedMediaFileLevelResource20 callWaitingVideoFile

Constructor Detail

UserCustomRingbackUserModifyCriteriaRequest

public UserCustomRingbackUserModifyCriteriaRequest()

UserCustomRingbackUserModifyCriteriaRequest

public UserCustomRingbackUserModifyCriteriaRequest(BroadWorksUser user,
                                                   String criteriaName)

Method Detail

setUser

public UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setCriteriaName

public UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest setCriteriaName(String criteriaName)

getCriteriaName

public String getCriteriaName()

setNewCriteriaName

public UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest setNewCriteriaName(String newCriteriaName)

getNewCriteriaName

public String getNewCriteriaName()

unsetTimeSchedule

public UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest unsetTimeSchedule()

setTimeSchedule

public UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest setTimeSchedule(TimeSchedule timeSchedule)

getTimeSchedule

public Optional<@Valid TimeSchedule> getTimeSchedule()

unsetHolidaySchedule

public UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest unsetHolidaySchedule()

setHolidaySchedule

public UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest setHolidaySchedule(HolidaySchedule holidaySchedule)

getHolidaySchedule

public Optional<@Valid HolidaySchedule> getHolidaySchedule()

setBlacklisted

public UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest setBlacklisted(Boolean blacklisted)

getBlacklisted

public Boolean getBlacklisted()

setFromDnCriteria

public UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest setFromDnCriteria(CriteriaFromDnModify fromDnCriteria)

getFromDnCriteria

public CriteriaFromDnModify getFromDnCriteria()

unsetCallToNumberList

public UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest unsetCallToNumberList()

setCallToNumberList

public UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest setCallToNumberList(ReplacementCallToNumberList callToNumberList)

getCallToNumberList

public Optional<@Valid ReplacementCallToNumberList> getCallToNumberList()

setAudioSelection

public UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest setAudioSelection(ExtendedFileResourceSelection audioSelection)

getAudioSelection

public ExtendedFileResourceSelection getAudioSelection()

setAudioFile

public UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest setAudioFile(ExtendedMediaFileLevelResource20 audioFile)

getAudioFile

public ExtendedMediaFileLevelResource20 getAudioFile()

setVideoSelection

public UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest setVideoSelection(ExtendedFileResourceSelection videoSelection)

getVideoSelection

public ExtendedFileResourceSelection getVideoSelection()

setVideoFile

public UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest setVideoFile(ExtendedMediaFileLevelResource20 videoFile)

getVideoFile

public ExtendedMediaFileLevelResource20 getVideoFile()

setCallWaitingAudioSelection

public UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest setCallWaitingAudioSelection(ExtendedFileResourceSelection callWaitingAudioSelection)

getCallWaitingAudioSelection

public ExtendedFileResourceSelection getCallWaitingAudioSelection()

setCallWaitingAudioFile

public UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest setCallWaitingAudioFile(ExtendedMediaFileLevelResource20 callWaitingAudioFile)

getCallWaitingAudioFile

public ExtendedMediaFileLevelResource20 getCallWaitingAudioFile()

setCallWaitingVideoSelection

public UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest setCallWaitingVideoSelection(ExtendedFileResourceSelection callWaitingVideoSelection)

getCallWaitingVideoSelection

public ExtendedFileResourceSelection getCallWaitingVideoSelection()

setCallWaitingVideoFile

public UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest setCallWaitingVideoFile(ExtendedMediaFileLevelResource20 callWaitingVideoFile)

getCallWaitingVideoFile

public ExtendedMediaFileLevelResource20 getCallWaitingVideoFile()

getEmptyObject

public static UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest 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>