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

Class GroupMusicOnHold.GroupMusicOnHoldAddInstanceRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.services.GroupMusicOnHold.GroupMusicOnHoldAddInstanceRequest

Enclosing class:

GroupMusicOnHold

public static class GroupMusicOnHold.GroupMusicOnHoldAddInstanceRequest
extends Request<DefaultResponse>

Add a Music on Hold Instance to a department. The response is either SuccessResponse or ErrorResponse. The following elements are only used in AS data mode and ignored in XS data mode: - useDynamicMOHDuringCallHold

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 @Valid DepartmentKey	department
protected @NotNull @Valid Group	group
protected @Valid MusicOnHoldSourceAddRI	internalSource
protected @NotNull Boolean	isActiveDuringBusyCampOn
protected @NotNull Boolean	isActiveDuringCallHold
protected @NotNull Boolean	isActiveDuringCallPark
protected @NotNull @Valid MusicOnHoldSourceAddRI	source
protected @NotNull Boolean	useAlternateSourceForInternalCalls
protected @NotNull Boolean	useDynamicMOHDuringCallHold

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

log

Constructor Summary

Constructors

Constructor	Description
GroupMusicOnHoldAddInstanceRequest()
GroupMusicOnHoldAddInstanceRequest(Group group, DepartmentKey department, Boolean isActiveDuringCallHold, Boolean isActiveDuringCallPark, Boolean isActiveDuringBusyCampOn, MusicOnHoldSourceAddRI source, Boolean useAlternateSourceForInternalCalls, Boolean useDynamicMOHDuringCallHold)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
DepartmentKey	getDepartment()
static GroupMusicOnHold.GroupMusicOnHoldAddInstanceRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Group	getGroup()
MusicOnHoldSourceAddRI	getInternalSource()
Boolean	getIsActiveDuringBusyCampOn()
Boolean	getIsActiveDuringCallHold()
Boolean	getIsActiveDuringCallPark()
MusicOnHoldSourceAddRI	getSource()
Boolean	getUseAlternateSourceForInternalCalls()
Boolean	getUseDynamicMOHDuringCallHold()
GroupMusicOnHold.GroupMusicOnHoldAddInstanceRequest	setDepartment(DepartmentKey department)
GroupMusicOnHold.GroupMusicOnHoldAddInstanceRequest	setGroup(Group group)
GroupMusicOnHold.GroupMusicOnHoldAddInstanceRequest	setInternalSource(MusicOnHoldSourceAddRI internalSource)
GroupMusicOnHold.GroupMusicOnHoldAddInstanceRequest	setIsActiveDuringBusyCampOn(Boolean isActiveDuringBusyCampOn)
GroupMusicOnHold.GroupMusicOnHoldAddInstanceRequest	setIsActiveDuringCallHold(Boolean isActiveDuringCallHold)
GroupMusicOnHold.GroupMusicOnHoldAddInstanceRequest	setIsActiveDuringCallPark(Boolean isActiveDuringCallPark)
GroupMusicOnHold.GroupMusicOnHoldAddInstanceRequest	setSource(MusicOnHoldSourceAddRI source)
GroupMusicOnHold.GroupMusicOnHoldAddInstanceRequest	setUseAlternateSourceForInternalCalls(Boolean useAlternateSourceForInternalCalls)
GroupMusicOnHold.GroupMusicOnHoldAddInstanceRequest	setUseDynamicMOHDuringCallHold(Boolean useDynamicMOHDuringCallHold)

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

group

@NotNull
@Valid
protected transient @NotNull @Valid Group group

department

@NotNull
@Valid
protected @NotNull @Valid DepartmentKey department

isActiveDuringCallHold

@NotNull
protected @NotNull Boolean isActiveDuringCallHold

isActiveDuringCallPark

@NotNull
protected @NotNull Boolean isActiveDuringCallPark

isActiveDuringBusyCampOn

@NotNull
protected @NotNull Boolean isActiveDuringBusyCampOn

source

@NotNull
@Valid
protected @NotNull @Valid MusicOnHoldSourceAddRI source

useAlternateSourceForInternalCalls

@NotNull
protected @NotNull Boolean useAlternateSourceForInternalCalls

internalSource

@Valid
protected @Valid MusicOnHoldSourceAddRI internalSource

useDynamicMOHDuringCallHold

@NotNull
protected @NotNull Boolean useDynamicMOHDuringCallHold

Constructor Details

GroupMusicOnHoldAddInstanceRequest

public GroupMusicOnHoldAddInstanceRequest()

GroupMusicOnHoldAddInstanceRequest

public GroupMusicOnHoldAddInstanceRequest(Group group,
 DepartmentKey department,
 Boolean isActiveDuringCallHold,
 Boolean isActiveDuringCallPark,
 Boolean isActiveDuringBusyCampOn,
 MusicOnHoldSourceAddRI source,
 Boolean useAlternateSourceForInternalCalls,
 Boolean useDynamicMOHDuringCallHold)

Method Details

setGroup

public GroupMusicOnHold.GroupMusicOnHoldAddInstanceRequest setGroup(Group group)

getGroup

public Group getGroup()

setDepartment

public GroupMusicOnHold.GroupMusicOnHoldAddInstanceRequest setDepartment(DepartmentKey department)

getDepartment

public DepartmentKey getDepartment()

setIsActiveDuringCallHold

public GroupMusicOnHold.GroupMusicOnHoldAddInstanceRequest setIsActiveDuringCallHold(Boolean isActiveDuringCallHold)

getIsActiveDuringCallHold

public Boolean getIsActiveDuringCallHold()

setIsActiveDuringCallPark

public GroupMusicOnHold.GroupMusicOnHoldAddInstanceRequest setIsActiveDuringCallPark(Boolean isActiveDuringCallPark)

getIsActiveDuringCallPark

public Boolean getIsActiveDuringCallPark()

setIsActiveDuringBusyCampOn

public GroupMusicOnHold.GroupMusicOnHoldAddInstanceRequest setIsActiveDuringBusyCampOn(Boolean isActiveDuringBusyCampOn)

getIsActiveDuringBusyCampOn

public Boolean getIsActiveDuringBusyCampOn()

setSource

public GroupMusicOnHold.GroupMusicOnHoldAddInstanceRequest setSource(MusicOnHoldSourceAddRI source)

getSource

public MusicOnHoldSourceAddRI getSource()

setUseAlternateSourceForInternalCalls

public GroupMusicOnHold.GroupMusicOnHoldAddInstanceRequest setUseAlternateSourceForInternalCalls(Boolean useAlternateSourceForInternalCalls)

getUseAlternateSourceForInternalCalls

public Boolean getUseAlternateSourceForInternalCalls()

setInternalSource

public GroupMusicOnHold.GroupMusicOnHoldAddInstanceRequest setInternalSource(MusicOnHoldSourceAddRI internalSource)

getInternalSource

public MusicOnHoldSourceAddRI getInternalSource()

setUseDynamicMOHDuringCallHold

public GroupMusicOnHold.GroupMusicOnHoldAddInstanceRequest setUseDynamicMOHDuringCallHold(Boolean useDynamicMOHDuringCallHold)

getUseDynamicMOHDuringCallHold

public Boolean getUseDynamicMOHDuringCallHold()

getEmptyObject

public static GroupMusicOnHold.GroupMusicOnHoldAddInstanceRequest 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>