Package co.ecg.alpaca.toolkit.generated

Class GroupAccessDevice.GroupAccessDeviceAddRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.GroupAccessDevice.GroupAccessDeviceAddRequest

Enclosing class:

GroupAccessDevice

@ChoiceGroup({"serviceProviderId","groupId","deviceName"}) @ChoiceGroup({"groupExternalId","deviceExternalId"})
public static class GroupAccessDevice.GroupAccessDeviceAddRequest
extends Request<DefaultResponse>

Request to add a group access device. The response is either SuccessResponse or ErrorResponse. The following elements are only used in AS data mode and ignored in XS data mode: groupExternalId deviceExternalId

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 DeviceManagementUserNamePassword16	accessDeviceCredentials
protected @Size(min=1,max=80) String	description
protected @Size(max=36) String	deviceExternalId
protected @Size(min=1,max=40) String	deviceName
protected @NotNull @Size(min=1,max=40) String	deviceType
protected @Size(max=36) String	groupExternalId
protected @Size(min=1,max=30) String	groupId
protected @Size(min=1,max=12) String	macAddress
protected @Size(min=1,max=80) String	netAddress
protected @Size(min=1,max=80) String	outboundProxyServerNetAddress
protected @Size(min=1,max=1024) String	physicalLocation
protected Integer	port
protected @Size(min=1,max=20) String	protocol
protected @Size(min=1,max=80) String	serialNumber
protected @Size(min=1,max=30) String	serviceProviderId
protected @Size(min=1,max=80) String	stunServerNetAddress
protected ExtendedTransportProtocol	transportProtocol
protected Boolean	useCustomUserNamePassword

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

log

Constructor Summary

Constructors

Constructor	Description
GroupAccessDeviceAddRequest()
GroupAccessDeviceAddRequest(BroadWorksServer broadWorksServer, String deviceType)
GroupAccessDeviceAddRequest(BroadWorksServer broadWorksServer, String groupExternalId, String deviceExternalId, String deviceType)
GroupAccessDeviceAddRequest(BroadWorksServer broadWorksServer, String serviceProviderId, String groupId, String deviceName, String deviceType)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
DeviceManagementUserNamePassword16	getAccessDeviceCredentials()
String	getDescription()
String	getDeviceExternalId()
String	getDeviceName()
String	getDeviceType()
static GroupAccessDevice.GroupAccessDeviceAddRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getGroupExternalId()
String	getGroupId()
String	getMacAddress()
String	getNetAddress()
String	getOutboundProxyServerNetAddress()
String	getPhysicalLocation()
Integer	getPort()
String	getProtocol()
String	getSerialNumber()
String	getServiceProviderId()
String	getStunServerNetAddress()
ExtendedTransportProtocol	getTransportProtocol()
Boolean	getUseCustomUserNamePassword()
GroupAccessDevice.GroupAccessDeviceAddRequest	setAccessDeviceCredentials(DeviceManagementUserNamePassword16 accessDeviceCredentials)
GroupAccessDevice.GroupAccessDeviceAddRequest	setDescription(String description)
GroupAccessDevice.GroupAccessDeviceAddRequest	setDeviceExternalId(String deviceExternalId)
GroupAccessDevice.GroupAccessDeviceAddRequest	setDeviceName(String deviceName)
GroupAccessDevice.GroupAccessDeviceAddRequest	setDeviceType(String deviceType)
GroupAccessDevice.GroupAccessDeviceAddRequest	setGroupExternalId(String groupExternalId)
GroupAccessDevice.GroupAccessDeviceAddRequest	setGroupId(String groupId)
GroupAccessDevice.GroupAccessDeviceAddRequest	setMacAddress(String macAddress)
GroupAccessDevice.GroupAccessDeviceAddRequest	setNetAddress(String netAddress)
GroupAccessDevice.GroupAccessDeviceAddRequest	setOutboundProxyServerNetAddress(String outboundProxyServerNetAddress)
GroupAccessDevice.GroupAccessDeviceAddRequest	setPhysicalLocation(String physicalLocation)
GroupAccessDevice.GroupAccessDeviceAddRequest	setPort(Integer port)
GroupAccessDevice.GroupAccessDeviceAddRequest	setProtocol(String protocol)
GroupAccessDevice.GroupAccessDeviceAddRequest	setSerialNumber(String serialNumber)
GroupAccessDevice.GroupAccessDeviceAddRequest	setServiceProviderId(String serviceProviderId)
GroupAccessDevice.GroupAccessDeviceAddRequest	setStunServerNetAddress(String stunServerNetAddress)
GroupAccessDevice.GroupAccessDeviceAddRequest	setTransportProtocol(ExtendedTransportProtocol transportProtocol)
GroupAccessDevice.GroupAccessDeviceAddRequest	setUseCustomUserNamePassword(Boolean useCustomUserNamePassword)

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

serviceProviderId

@Size(min=1,
      max=30)
protected @Size(min=1,max=30) String serviceProviderId

groupId

@Size(min=1,
      max=30)
protected @Size(min=1,max=30) String groupId

deviceName

@Size(min=1,
      max=40)
protected @Size(min=1,max=40) String deviceName

groupExternalId

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

deviceExternalId

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

deviceType

@NotNull
@Size(min=1,
      max=40)
protected @NotNull @Size(min=1,max=40) String deviceType

protocol

@Size(min=1,
      max=20)
protected @Size(min=1,max=20) String protocol

netAddress

@Size(min=1,
      max=80)
protected @Size(min=1,max=80) String netAddress

port

protected Integer port

outboundProxyServerNetAddress

@Size(min=1,
      max=80)
protected @Size(min=1,max=80) String outboundProxyServerNetAddress

stunServerNetAddress

@Size(min=1,
      max=80)
protected @Size(min=1,max=80) String stunServerNetAddress

macAddress

@Size(min=1,
      max=12)
protected @Size(min=1,max=12) String macAddress

serialNumber

@Size(min=1,
      max=80)
protected @Size(min=1,max=80) String serialNumber

description

@Size(min=1,
      max=80)
protected @Size(min=1,max=80) String description

physicalLocation

@Size(min=1,
      max=1024)
protected @Size(min=1,max=1024) String physicalLocation

transportProtocol

protected ExtendedTransportProtocol transportProtocol

useCustomUserNamePassword

protected Boolean useCustomUserNamePassword

accessDeviceCredentials

@Valid
protected @Valid DeviceManagementUserNamePassword16 accessDeviceCredentials

Constructor Details

GroupAccessDeviceAddRequest

public GroupAccessDeviceAddRequest()

GroupAccessDeviceAddRequest

public GroupAccessDeviceAddRequest(BroadWorksServer broadWorksServer,
 String deviceType)

GroupAccessDeviceAddRequest

public GroupAccessDeviceAddRequest(BroadWorksServer broadWorksServer,
 String serviceProviderId,
 String groupId,
 String deviceName,
 String deviceType)

GroupAccessDeviceAddRequest

public GroupAccessDeviceAddRequest(BroadWorksServer broadWorksServer,
 String groupExternalId,
 String deviceExternalId,
 String deviceType)

Method Details

setServiceProviderId

public GroupAccessDevice.GroupAccessDeviceAddRequest setServiceProviderId(String serviceProviderId)

getServiceProviderId

public String getServiceProviderId()

setGroupId

public GroupAccessDevice.GroupAccessDeviceAddRequest setGroupId(String groupId)

getGroupId

public String getGroupId()

setDeviceName

public GroupAccessDevice.GroupAccessDeviceAddRequest setDeviceName(String deviceName)

getDeviceName

public String getDeviceName()

setGroupExternalId

public GroupAccessDevice.GroupAccessDeviceAddRequest setGroupExternalId(String groupExternalId)

getGroupExternalId

public String getGroupExternalId()

setDeviceExternalId

public GroupAccessDevice.GroupAccessDeviceAddRequest setDeviceExternalId(String deviceExternalId)

getDeviceExternalId

public String getDeviceExternalId()

setDeviceType

public GroupAccessDevice.GroupAccessDeviceAddRequest setDeviceType(String deviceType)

getDeviceType

public String getDeviceType()

setProtocol

public GroupAccessDevice.GroupAccessDeviceAddRequest setProtocol(String protocol)

getProtocol

public String getProtocol()

setNetAddress

public GroupAccessDevice.GroupAccessDeviceAddRequest setNetAddress(String netAddress)

getNetAddress

public String getNetAddress()

setPort

public GroupAccessDevice.GroupAccessDeviceAddRequest setPort(Integer port)

getPort

public Integer getPort()

setOutboundProxyServerNetAddress

public GroupAccessDevice.GroupAccessDeviceAddRequest setOutboundProxyServerNetAddress(String outboundProxyServerNetAddress)

getOutboundProxyServerNetAddress

public String getOutboundProxyServerNetAddress()

setStunServerNetAddress

public GroupAccessDevice.GroupAccessDeviceAddRequest setStunServerNetAddress(String stunServerNetAddress)

getStunServerNetAddress

public String getStunServerNetAddress()

setMacAddress

public GroupAccessDevice.GroupAccessDeviceAddRequest setMacAddress(String macAddress)

getMacAddress

public String getMacAddress()

setSerialNumber

public GroupAccessDevice.GroupAccessDeviceAddRequest setSerialNumber(String serialNumber)

getSerialNumber

public String getSerialNumber()

setDescription

public GroupAccessDevice.GroupAccessDeviceAddRequest setDescription(String description)

getDescription

public String getDescription()

setPhysicalLocation

public GroupAccessDevice.GroupAccessDeviceAddRequest setPhysicalLocation(String physicalLocation)

getPhysicalLocation

public String getPhysicalLocation()

setTransportProtocol

public GroupAccessDevice.GroupAccessDeviceAddRequest setTransportProtocol(ExtendedTransportProtocol transportProtocol)

getTransportProtocol

public ExtendedTransportProtocol getTransportProtocol()

setUseCustomUserNamePassword

public GroupAccessDevice.GroupAccessDeviceAddRequest setUseCustomUserNamePassword(Boolean useCustomUserNamePassword)

getUseCustomUserNamePassword

public Boolean getUseCustomUserNamePassword()

setAccessDeviceCredentials

public GroupAccessDevice.GroupAccessDeviceAddRequest setAccessDeviceCredentials(DeviceManagementUserNamePassword16 accessDeviceCredentials)

getAccessDeviceCredentials

public DeviceManagementUserNamePassword16 getAccessDeviceCredentials()

getEmptyObject

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