Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemSIPModifyACLEntryRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemSIPModifyACLEntryRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemSIPModifyACLEntryRequest
extends Request<DefaultResponse>

Modify an entry from the SIP access control list. The response is either SuccessResponse 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 Optional<@Size(min=1,max=80) String>	description
protected @NotNull @Size(min=1,max=39) String	netAddress
protected SIPACLTransportProtocol	transportProtocol

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

log

Constructor Summary

Constructors

Constructor	Description
SystemSIPModifyACLEntryRequest()
SystemSIPModifyACLEntryRequest(BroadWorksServer broadWorksServer, String netAddress)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
Optional<@Size(min=1,max=80) String>	getDescription()
static BWSystem.SystemSIPModifyACLEntryRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getNetAddress()
SIPACLTransportProtocol	getTransportProtocol()
BWSystem.SystemSIPModifyACLEntryRequest	setDescription(String description)
BWSystem.SystemSIPModifyACLEntryRequest	setNetAddress(String netAddress)
BWSystem.SystemSIPModifyACLEntryRequest	setTransportProtocol(SIPACLTransportProtocol transportProtocol)
BWSystem.SystemSIPModifyACLEntryRequest	unsetDescription()

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

netAddress

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

transportProtocol

protected SIPACLTransportProtocol transportProtocol

description

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

Constructor Details

SystemSIPModifyACLEntryRequest

public SystemSIPModifyACLEntryRequest()

SystemSIPModifyACLEntryRequest

public SystemSIPModifyACLEntryRequest(BroadWorksServer broadWorksServer,
 String netAddress)

Method Details

setNetAddress

public BWSystem.SystemSIPModifyACLEntryRequest setNetAddress(String netAddress)

getNetAddress

public String getNetAddress()

setTransportProtocol

public BWSystem.SystemSIPModifyACLEntryRequest setTransportProtocol(SIPACLTransportProtocol transportProtocol)

getTransportProtocol

public SIPACLTransportProtocol getTransportProtocol()

unsetDescription

public BWSystem.SystemSIPModifyACLEntryRequest unsetDescription()

setDescription

public BWSystem.SystemSIPModifyACLEntryRequest setDescription(String description)

getDescription

public Optional<@Size(min=1,max=80) String> getDescription()

getEmptyObject

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