Package co.ecg.alpaca.toolkit.generated

Class GroupAccessDevice.GroupAccessDeviceGetAvailableDetailListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<GroupAccessDevice.GroupAccessDeviceGetAvailableDetailListResponse>

co.ecg.alpaca.toolkit.generated.GroupAccessDevice.GroupAccessDeviceGetAvailableDetailListRequest

Enclosing class:

GroupAccessDevice

public static class GroupAccessDevice.GroupAccessDeviceGetAvailableDetailListRequest
extends Request<GroupAccessDevice.GroupAccessDeviceGetAvailableDetailListResponse>

Requests the list of available access devices for assignment to a user within a group. The list includes devices created at the system, service provider, and group levels. The following elements are used in AS mode and ignored in XS data mode: onlyIntelligentDevice The response is either GroupAccessDeviceGetAvailableDetailListResponse19 or 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 @Valid Group	group
protected @NotNull Boolean	isMusicOnHold
protected Boolean	onlyIntelligentDevice
protected @NotNull Boolean	onlyVideoCapable

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

log

Constructor Summary

Constructors

Constructor	Description
GroupAccessDeviceGetAvailableDetailListRequest()
GroupAccessDeviceGetAvailableDetailListRequest(Group group, Boolean isMusicOnHold, Boolean onlyVideoCapable)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static GroupAccessDevice.GroupAccessDeviceGetAvailableDetailListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Group	getGroup()
Boolean	getIsMusicOnHold()
Boolean	getOnlyIntelligentDevice()
Boolean	getOnlyVideoCapable()
GroupAccessDevice.GroupAccessDeviceGetAvailableDetailListRequest	setGroup(Group group)
GroupAccessDevice.GroupAccessDeviceGetAvailableDetailListRequest	setIsMusicOnHold(Boolean isMusicOnHold)
GroupAccessDevice.GroupAccessDeviceGetAvailableDetailListRequest	setOnlyIntelligentDevice(Boolean onlyIntelligentDevice)
GroupAccessDevice.GroupAccessDeviceGetAvailableDetailListRequest	setOnlyVideoCapable(Boolean onlyVideoCapable)

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

isMusicOnHold

@NotNull
protected @NotNull Boolean isMusicOnHold

onlyVideoCapable

@NotNull
protected @NotNull Boolean onlyVideoCapable

onlyIntelligentDevice

protected Boolean onlyIntelligentDevice

Constructor Details

GroupAccessDeviceGetAvailableDetailListRequest

public GroupAccessDeviceGetAvailableDetailListRequest()

GroupAccessDeviceGetAvailableDetailListRequest

public GroupAccessDeviceGetAvailableDetailListRequest(Group group,
 Boolean isMusicOnHold,
 Boolean onlyVideoCapable)

Method Details

setGroup

public GroupAccessDevice.GroupAccessDeviceGetAvailableDetailListRequest setGroup(Group group)

getGroup

public Group getGroup()

setIsMusicOnHold

public GroupAccessDevice.GroupAccessDeviceGetAvailableDetailListRequest setIsMusicOnHold(Boolean isMusicOnHold)

getIsMusicOnHold

public Boolean getIsMusicOnHold()

setOnlyVideoCapable

public GroupAccessDevice.GroupAccessDeviceGetAvailableDetailListRequest setOnlyVideoCapable(Boolean onlyVideoCapable)

getOnlyVideoCapable

public Boolean getOnlyVideoCapable()

setOnlyIntelligentDevice

public GroupAccessDevice.GroupAccessDeviceGetAvailableDetailListRequest setOnlyIntelligentDevice(Boolean onlyIntelligentDevice)

getOnlyIntelligentDevice

public Boolean getOnlyIntelligentDevice()

getEmptyObject

public static GroupAccessDevice.GroupAccessDeviceGetAvailableDetailListRequest 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<GroupAccessDevice.GroupAccessDeviceGetAvailableDetailListResponse>