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

Class GroupMusicOnHold.GroupMusicOnHoldGetDepartmentListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<GroupMusicOnHold.GroupMusicOnHoldGetDepartmentListResponse>

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

Enclosing class:

GroupMusicOnHold

public static class GroupMusicOnHold.GroupMusicOnHoldGetDepartmentListRequest
extends Request<GroupMusicOnHold.GroupMusicOnHoldGetDepartmentListResponse>

Returns a list of all departments that have a Music On Hold instance. The response is either GroupMusicOnHoldGetDepartmentListResponse or ErrorResponse. It is possible to get the instances within a specified department.

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 Group	group
protected @Size(min=1,max=50) String	groupDepartmentName

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

log

Constructor Summary

Constructors

Constructor	Description
GroupMusicOnHoldGetDepartmentListRequest()
GroupMusicOnHoldGetDepartmentListRequest(Group group)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static GroupMusicOnHold.GroupMusicOnHoldGetDepartmentListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Group	getGroup()
String	getGroupDepartmentName()
GroupMusicOnHold.GroupMusicOnHoldGetDepartmentListRequest	setGroup(Group group)
GroupMusicOnHold.GroupMusicOnHoldGetDepartmentListRequest	setGroupDepartmentName(String groupDepartmentName)

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

groupDepartmentName

@Size(min=1,
      max=50)
protected @Size(min=1,max=50) String groupDepartmentName

Constructor Details

GroupMusicOnHoldGetDepartmentListRequest

public GroupMusicOnHoldGetDepartmentListRequest()

GroupMusicOnHoldGetDepartmentListRequest

public GroupMusicOnHoldGetDepartmentListRequest(Group group)

Method Details

setGroup

public GroupMusicOnHold.GroupMusicOnHoldGetDepartmentListRequest setGroup(Group group)

getGroup

public Group getGroup()

setGroupDepartmentName

public GroupMusicOnHold.GroupMusicOnHoldGetDepartmentListRequest setGroupDepartmentName(String groupDepartmentName)

getGroupDepartmentName

public String getGroupDepartmentName()

getEmptyObject

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