Package co.ecg.alpaca.toolkit.generated

Class SystemAccessDevice.SystemAccessDeviceModifyUserRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.SystemAccessDevice.SystemAccessDeviceModifyUserRequest

Enclosing class:

SystemAccessDevice

public static class SystemAccessDevice.SystemAccessDeviceModifyUserRequest
extends Request<DefaultResponse>

Request to modify attributes for line/ports assigned on the system 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 Boolean	isPrimaryLinePort
protected @NotNull @Size(min=1,max=161) String	linePort
protected @Size(min=1,max=161) String	privateIdentity
protected @NotNull @Valid SystemAccessDevice	systemAccessDevice

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

log

Constructor Summary

Constructors

Constructor	Description
SystemAccessDeviceModifyUserRequest()
SystemAccessDeviceModifyUserRequest(SystemAccessDevice systemAccessDevice, String linePort)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static SystemAccessDevice.SystemAccessDeviceModifyUserRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Boolean	getIsPrimaryLinePort()
String	getLinePort()
String	getPrivateIdentity()
SystemAccessDevice	getSystemAccessDevice()
SystemAccessDevice.SystemAccessDeviceModifyUserRequest	setIsPrimaryLinePort(Boolean isPrimaryLinePort)
SystemAccessDevice.SystemAccessDeviceModifyUserRequest	setLinePort(String linePort)
SystemAccessDevice.SystemAccessDeviceModifyUserRequest	setPrivateIdentity(String privateIdentity)
SystemAccessDevice.SystemAccessDeviceModifyUserRequest	setSystemAccessDevice(SystemAccessDevice systemAccessDevice)

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

systemAccessDevice

@NotNull
@Valid
protected transient @NotNull @Valid SystemAccessDevice systemAccessDevice

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 Details

SystemAccessDeviceModifyUserRequest

public SystemAccessDeviceModifyUserRequest()

SystemAccessDeviceModifyUserRequest

public SystemAccessDeviceModifyUserRequest(SystemAccessDevice systemAccessDevice,
 String linePort)

Method Details

setSystemAccessDevice

public SystemAccessDevice.SystemAccessDeviceModifyUserRequest setSystemAccessDevice(SystemAccessDevice systemAccessDevice)

getSystemAccessDevice

public SystemAccessDevice getSystemAccessDevice()

setLinePort

public SystemAccessDevice.SystemAccessDeviceModifyUserRequest setLinePort(String linePort)

getLinePort

public String getLinePort()

setPrivateIdentity

public SystemAccessDevice.SystemAccessDeviceModifyUserRequest setPrivateIdentity(String privateIdentity)

getPrivateIdentity

public String getPrivateIdentity()

setIsPrimaryLinePort

public SystemAccessDevice.SystemAccessDeviceModifyUserRequest setIsPrimaryLinePort(Boolean isPrimaryLinePort)

getIsPrimaryLinePort

public Boolean getIsPrimaryLinePort()

getEmptyObject

public static SystemAccessDevice.SystemAccessDeviceModifyUserRequest 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>