Package co.ecg.alpaca.toolkit.generated

Class GroupAccessDevice.GroupAccessDeviceGetListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.GroupAccessDevice.GroupAccessDeviceGetListRequest

Enclosing class:

GroupAccessDevice

@ChoiceGroup("groupExternalId") @ChoiceGroup({"serviceProvider","group"})
public static class GroupAccessDevice.GroupAccessDeviceGetListRequest
extends Request<GroupAccessDevice.GroupAccessDeviceGetListResponse>

Requests the list of access devices in a group. The following elements are only used in AS data mode and ignored in XS data mode: groupExternalId The response is either GroupAccessDeviceGetListResponse 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 @Valid Group	group
protected @Size(max=36) String	groupExternalId
protected Integer	responseSizeLimit
protected @Valid SearchCriteriaAccessDeviceVersion[]	searchCriteriaAccessDeviceVersion
protected @Valid SearchCriteriaDeviceMACAddress[]	searchCriteriaDeviceMACAddress
protected @Valid SearchCriteriaDeviceName[]	searchCriteriaDeviceName
protected @Valid SearchCriteriaDeviceNetAddress[]	searchCriteriaDeviceNetAddress
protected @Valid SearchCriteriaExactDeviceType	searchCriteriaExactDeviceType

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

log

Constructor Summary

Constructors

Constructor	Description
GroupAccessDeviceGetListRequest()
GroupAccessDeviceGetListRequest(Group group)
GroupAccessDeviceGetListRequest(BroadWorksServer broadWorksServer)
GroupAccessDeviceGetListRequest(BroadWorksServer broadWorksServer, String groupExternalId)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
Group	getGroup()
String	getGroupExternalId()
Integer	getResponseSizeLimit()
SearchCriteriaAccessDeviceVersion[]	getSearchCriteriaAccessDeviceVersion()
SearchCriteriaDeviceMACAddress[]	getSearchCriteriaDeviceMACAddress()
SearchCriteriaDeviceName[]	getSearchCriteriaDeviceName()
SearchCriteriaDeviceNetAddress[]	getSearchCriteriaDeviceNetAddress()
SearchCriteriaExactDeviceType	getSearchCriteriaExactDeviceType()
GroupAccessDevice.GroupAccessDeviceGetListRequest	setGroup(Group group)
GroupAccessDevice.GroupAccessDeviceGetListRequest	setGroupExternalId(String groupExternalId)
GroupAccessDevice.GroupAccessDeviceGetListRequest	setResponseSizeLimit(Integer responseSizeLimit)
GroupAccessDevice.GroupAccessDeviceGetListRequest	setSearchCriteriaAccessDeviceVersion(SearchCriteriaAccessDeviceVersion... searchCriteriaAccessDeviceVersion)
GroupAccessDevice.GroupAccessDeviceGetListRequest	setSearchCriteriaDeviceMACAddress(SearchCriteriaDeviceMACAddress... searchCriteriaDeviceMACAddress)
GroupAccessDevice.GroupAccessDeviceGetListRequest	setSearchCriteriaDeviceName(SearchCriteriaDeviceName... searchCriteriaDeviceName)
GroupAccessDevice.GroupAccessDeviceGetListRequest	setSearchCriteriaDeviceNetAddress(SearchCriteriaDeviceNetAddress... searchCriteriaDeviceNetAddress)
GroupAccessDevice.GroupAccessDeviceGetListRequest	setSearchCriteriaExactDeviceType(SearchCriteriaExactDeviceType searchCriteriaExactDeviceType)

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

group

@Valid
protected transient @Valid Group group

groupExternalId

@Size(max=36)
protected @Size(max=36) String groupExternalId

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaDeviceName

@Valid
protected @Valid SearchCriteriaDeviceName[] searchCriteriaDeviceName

searchCriteriaDeviceMACAddress

@Valid
protected @Valid SearchCriteriaDeviceMACAddress[] searchCriteriaDeviceMACAddress

searchCriteriaDeviceNetAddress

@Valid
protected @Valid SearchCriteriaDeviceNetAddress[] searchCriteriaDeviceNetAddress

searchCriteriaExactDeviceType

@Valid
protected @Valid SearchCriteriaExactDeviceType searchCriteriaExactDeviceType

searchCriteriaAccessDeviceVersion

@Valid
protected @Valid SearchCriteriaAccessDeviceVersion[] searchCriteriaAccessDeviceVersion

Constructor Detail

GroupAccessDeviceGetListRequest

public GroupAccessDeviceGetListRequest()

GroupAccessDeviceGetListRequest

public GroupAccessDeviceGetListRequest(BroadWorksServer broadWorksServer)

GroupAccessDeviceGetListRequest

public GroupAccessDeviceGetListRequest(Group group)

GroupAccessDeviceGetListRequest

public GroupAccessDeviceGetListRequest(BroadWorksServer broadWorksServer,
                                       String groupExternalId)

Method Detail

setGroup

public GroupAccessDevice.GroupAccessDeviceGetListRequest setGroup(Group group)

getGroup

public Group getGroup()

setGroupExternalId

public GroupAccessDevice.GroupAccessDeviceGetListRequest setGroupExternalId(String groupExternalId)

getGroupExternalId

public String getGroupExternalId()

setResponseSizeLimit

public GroupAccessDevice.GroupAccessDeviceGetListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaDeviceName

public GroupAccessDevice.GroupAccessDeviceGetListRequest setSearchCriteriaDeviceName(SearchCriteriaDeviceName... searchCriteriaDeviceName)

getSearchCriteriaDeviceName

public SearchCriteriaDeviceName[] getSearchCriteriaDeviceName()

setSearchCriteriaDeviceMACAddress

public GroupAccessDevice.GroupAccessDeviceGetListRequest setSearchCriteriaDeviceMACAddress(SearchCriteriaDeviceMACAddress... searchCriteriaDeviceMACAddress)

getSearchCriteriaDeviceMACAddress

public SearchCriteriaDeviceMACAddress[] getSearchCriteriaDeviceMACAddress()

setSearchCriteriaDeviceNetAddress

public GroupAccessDevice.GroupAccessDeviceGetListRequest setSearchCriteriaDeviceNetAddress(SearchCriteriaDeviceNetAddress... searchCriteriaDeviceNetAddress)

getSearchCriteriaDeviceNetAddress

public SearchCriteriaDeviceNetAddress[] getSearchCriteriaDeviceNetAddress()

setSearchCriteriaExactDeviceType

public GroupAccessDevice.GroupAccessDeviceGetListRequest setSearchCriteriaExactDeviceType(SearchCriteriaExactDeviceType searchCriteriaExactDeviceType)

getSearchCriteriaExactDeviceType

public SearchCriteriaExactDeviceType getSearchCriteriaExactDeviceType()

setSearchCriteriaAccessDeviceVersion

public GroupAccessDevice.GroupAccessDeviceGetListRequest setSearchCriteriaAccessDeviceVersion(SearchCriteriaAccessDeviceVersion... searchCriteriaAccessDeviceVersion)

getSearchCriteriaAccessDeviceVersion

public SearchCriteriaAccessDeviceVersion[] getSearchCriteriaAccessDeviceVersion()

formRequest

public void formRequest()

Forms the XML Document for this Request Object. Called by the Request upon fire().

Overrides:

formRequest in class Request<GroupAccessDevice.GroupAccessDeviceGetListResponse>