Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemCPEConfigReorderDeviceLinePortsRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemCPEConfigReorderDeviceLinePortsRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemCPEConfigReorderDeviceLinePortsRequest
extends Request<DefaultResponse>

Reorder the lines of a System device. You can not add or delete line ports, only re-ordering the list is allowed. The ordered list of line ports can be obtained with the SystemAccessDeviceGetRequest16 command. The response is either a SuccessResponse or an 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 @Size(min=1) String[]	orderedLinePortList
protected @NotNull @Valid SystemAccessDevice	systemAccessDevice

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

log

Constructor Summary

Constructors

Constructor	Description
SystemCPEConfigReorderDeviceLinePortsRequest()
SystemCPEConfigReorderDeviceLinePortsRequest(SystemAccessDevice systemAccessDevice, String... orderedLinePortList)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static BWSystem.SystemCPEConfigReorderDeviceLinePortsRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String[]	getOrderedLinePortList()
SystemAccessDevice	getSystemAccessDevice()
BWSystem.SystemCPEConfigReorderDeviceLinePortsRequest	setOrderedLinePortList(String... orderedLinePortList)
BWSystem.SystemCPEConfigReorderDeviceLinePortsRequest	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 Detail

systemAccessDevice

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

orderedLinePortList

@NotNull
@Size(min=1)
@StringArrayElementSize(min=1,
                        max=161)
protected @NotNull @Size(min=1) String[] orderedLinePortList

Constructor Detail

SystemCPEConfigReorderDeviceLinePortsRequest

public SystemCPEConfigReorderDeviceLinePortsRequest()

SystemCPEConfigReorderDeviceLinePortsRequest

public SystemCPEConfigReorderDeviceLinePortsRequest(SystemAccessDevice systemAccessDevice,
                                                    String... orderedLinePortList)

Method Detail

setSystemAccessDevice

public BWSystem.SystemCPEConfigReorderDeviceLinePortsRequest setSystemAccessDevice(SystemAccessDevice systemAccessDevice)

getSystemAccessDevice

public SystemAccessDevice getSystemAccessDevice()

setOrderedLinePortList

public BWSystem.SystemCPEConfigReorderDeviceLinePortsRequest setOrderedLinePortList(String... orderedLinePortList)

getOrderedLinePortList

public String[] getOrderedLinePortList()

getEmptyObject

public static BWSystem.SystemCPEConfigReorderDeviceLinePortsRequest 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>