Package co.ecg.alpaca.toolkit.generated

Class GroupAccessDevice.GroupAccessDeviceModifyUserRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.GroupAccessDevice.GroupAccessDeviceModifyUserRequest

Enclosing class:

GroupAccessDevice

public static class GroupAccessDevice.GroupAccessDeviceModifyUserRequest
extends Request<DefaultResponse>

Request to modify attributes for line/ports assigned on the group device profile. The response is either SuccessResponse or ErrorResponse. The following elements are only used in XS data mode and ignored in AS data mode: privateIdentity

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 GroupAccessDevice	groupAccessDevice
protected Boolean	isPrimaryLinePort
protected @NotNull @Size(min=1,max=161) String	linePort
protected @Size(min=1,max=161) String	privateIdentity

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

log

Constructor Summary

Constructors

Constructor	Description
GroupAccessDeviceModifyUserRequest()
GroupAccessDeviceModifyUserRequest(GroupAccessDevice groupAccessDevice, String linePort)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static GroupAccessDevice.GroupAccessDeviceModifyUserRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
GroupAccessDevice	getGroupAccessDevice()
Boolean	getIsPrimaryLinePort()
String	getLinePort()
String	getPrivateIdentity()
GroupAccessDevice.GroupAccessDeviceModifyUserRequest	setGroupAccessDevice(GroupAccessDevice groupAccessDevice)
GroupAccessDevice.GroupAccessDeviceModifyUserRequest	setIsPrimaryLinePort(Boolean isPrimaryLinePort)
GroupAccessDevice.GroupAccessDeviceModifyUserRequest	setLinePort(String linePort)
GroupAccessDevice.GroupAccessDeviceModifyUserRequest	setPrivateIdentity(String privateIdentity)

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 Detail

groupAccessDevice

@NotNull
@Valid
protected transient @NotNull @Valid GroupAccessDevice groupAccessDevice

linePort

@NotNull
@Pattern(regexp="[a-zA-Z0-9._!~*\'()+-]+[@]{0,1}[a-zA-Z0-9.-]+")
@Size(min=1,
      max=161)
protected @NotNull @Size(min=1,max=161) String linePort

privateIdentity

@Size(min=1,
      max=161)
protected @Size(min=1,max=161) String privateIdentity

isPrimaryLinePort

protected Boolean isPrimaryLinePort

Constructor Detail

GroupAccessDeviceModifyUserRequest

public GroupAccessDeviceModifyUserRequest()

GroupAccessDeviceModifyUserRequest

public GroupAccessDeviceModifyUserRequest(GroupAccessDevice groupAccessDevice,
                                          String linePort)

Method Detail

setGroupAccessDevice

public GroupAccessDevice.GroupAccessDeviceModifyUserRequest setGroupAccessDevice(GroupAccessDevice groupAccessDevice)

getGroupAccessDevice

public GroupAccessDevice getGroupAccessDevice()

setLinePort

public GroupAccessDevice.GroupAccessDeviceModifyUserRequest setLinePort(String linePort)

getLinePort

public String getLinePort()

setPrivateIdentity

public GroupAccessDevice.GroupAccessDeviceModifyUserRequest setPrivateIdentity(String privateIdentity)

getPrivateIdentity

public String getPrivateIdentity()

setIsPrimaryLinePort

public GroupAccessDevice.GroupAccessDeviceModifyUserRequest setIsPrimaryLinePort(Boolean isPrimaryLinePort)

getIsPrimaryLinePort

public Boolean getIsPrimaryLinePort()

getEmptyObject

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