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

Class UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest

java.lang.Object

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

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

Enclosing class:

UserCustomRingback

public static class UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest
extends Request<DefaultResponse>

Add a criteria to the user's custom ringback service. 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 @Valid ExtendedMediaFileLevelResource20	audioFile
protected @NotNull ExtendedFileResourceSelection	audioSelection
protected @NotNull Boolean	blacklisted
protected @Valid CallToNumber[]	callToNumber
protected @Valid ExtendedMediaFileLevelResource20	callWaitingAudioFile
protected ExtendedFileResourceSelection	callWaitingAudioSelection
protected @Valid ExtendedMediaFileLevelResource20	callWaitingVideoFile
protected ExtendedFileResourceSelection	callWaitingVideoSelection
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
protected @Valid ExtendedMediaFileLevelResource20	videoFile
protected @NotNull ExtendedFileResourceSelection	videoSelection

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

log

Constructor Summary

Constructors

Constructor	Description
UserCustomRingbackUserAddCriteriaRequest()
UserCustomRingbackUserAddCriteriaRequest(BroadWorksUser user, String criteriaName, Boolean blacklisted, CriteriaFromDn fromDnCriteria, ExtendedFileResourceSelection audioSelection, ExtendedFileResourceSelection videoSelection)

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()
CallToNumber[]	getCallToNumber()
ExtendedMediaFileLevelResource20	getCallWaitingAudioFile()
ExtendedFileResourceSelection	getCallWaitingAudioSelection()
ExtendedMediaFileLevelResource20	getCallWaitingVideoFile()
ExtendedFileResourceSelection	getCallWaitingVideoSelection()
String	getCriteriaName()
static UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
CriteriaFromDn	getFromDnCriteria()
HolidaySchedule	getHolidaySchedule()
TimeSchedule	getTimeSchedule()
ExtendedMediaFileLevelResource20	getVideoFile()
ExtendedFileResourceSelection	getVideoSelection()
UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest	setAudioFile(ExtendedMediaFileLevelResource20 audioFile)
UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest	setAudioSelection(ExtendedFileResourceSelection audioSelection)
UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest	setBlacklisted(Boolean blacklisted)
UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest	setCallToNumber(CallToNumber... callToNumber)
UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest	setCallWaitingAudioFile(ExtendedMediaFileLevelResource20 callWaitingAudioFile)
UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest	setCallWaitingAudioSelection(ExtendedFileResourceSelection callWaitingAudioSelection)
UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest	setCallWaitingVideoFile(ExtendedMediaFileLevelResource20 callWaitingVideoFile)
UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest	setCallWaitingVideoSelection(ExtendedFileResourceSelection callWaitingVideoSelection)
UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest	setCriteriaName(String criteriaName)
UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest	setFromDnCriteria(CriteriaFromDn fromDnCriteria)
UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest	setHolidaySchedule(HolidaySchedule holidaySchedule)
UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest	setTimeSchedule(TimeSchedule timeSchedule)
UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest	setUser(BroadWorksUser user)
UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest	setVideoFile(ExtendedMediaFileLevelResource20 videoFile)
UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest	setVideoSelection(ExtendedFileResourceSelection videoSelection)

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

audioSelection

@NotNull
protected @NotNull ExtendedFileResourceSelection audioSelection

audioFile

@Valid
protected @Valid ExtendedMediaFileLevelResource20 audioFile

videoSelection

@NotNull
protected @NotNull 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 Details

UserCustomRingbackUserAddCriteriaRequest

public UserCustomRingbackUserAddCriteriaRequest()

UserCustomRingbackUserAddCriteriaRequest

public UserCustomRingbackUserAddCriteriaRequest(BroadWorksUser user,
 String criteriaName,
 Boolean blacklisted,
 CriteriaFromDn fromDnCriteria,
 ExtendedFileResourceSelection audioSelection,
 ExtendedFileResourceSelection videoSelection)

Method Details

setUser

public UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setCriteriaName

public UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest setCriteriaName(String criteriaName)

getCriteriaName

public String getCriteriaName()

setTimeSchedule

public UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest setTimeSchedule(TimeSchedule timeSchedule)

getTimeSchedule

public TimeSchedule getTimeSchedule()

setHolidaySchedule

public UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest setHolidaySchedule(HolidaySchedule holidaySchedule)

getHolidaySchedule

public HolidaySchedule getHolidaySchedule()

setBlacklisted

public UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest setBlacklisted(Boolean blacklisted)

getBlacklisted

public Boolean getBlacklisted()

setFromDnCriteria

public UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest setFromDnCriteria(CriteriaFromDn fromDnCriteria)

getFromDnCriteria

public CriteriaFromDn getFromDnCriteria()

setCallToNumber

public UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest setCallToNumber(CallToNumber... callToNumber)

getCallToNumber

public CallToNumber[] getCallToNumber()

setAudioSelection

public UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest setAudioSelection(ExtendedFileResourceSelection audioSelection)

getAudioSelection

public ExtendedFileResourceSelection getAudioSelection()

setAudioFile

public UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest setAudioFile(ExtendedMediaFileLevelResource20 audioFile)

getAudioFile

public ExtendedMediaFileLevelResource20 getAudioFile()

setVideoSelection

public UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest setVideoSelection(ExtendedFileResourceSelection videoSelection)

getVideoSelection

public ExtendedFileResourceSelection getVideoSelection()

setVideoFile

public UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest setVideoFile(ExtendedMediaFileLevelResource20 videoFile)

getVideoFile

public ExtendedMediaFileLevelResource20 getVideoFile()

setCallWaitingAudioSelection

public UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest setCallWaitingAudioSelection(ExtendedFileResourceSelection callWaitingAudioSelection)

getCallWaitingAudioSelection

public ExtendedFileResourceSelection getCallWaitingAudioSelection()

setCallWaitingAudioFile

public UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest setCallWaitingAudioFile(ExtendedMediaFileLevelResource20 callWaitingAudioFile)

getCallWaitingAudioFile

public ExtendedMediaFileLevelResource20 getCallWaitingAudioFile()

setCallWaitingVideoSelection

public UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest setCallWaitingVideoSelection(ExtendedFileResourceSelection callWaitingVideoSelection)

getCallWaitingVideoSelection

public ExtendedFileResourceSelection getCallWaitingVideoSelection()

setCallWaitingVideoFile

public UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest setCallWaitingVideoFile(ExtendedMediaFileLevelResource20 callWaitingVideoFile)

getCallWaitingVideoFile

public ExtendedMediaFileLevelResource20 getCallWaitingVideoFile()

getEmptyObject

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