Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemOCIReportingModifyACLEntryRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemOCIReportingModifyACLEntryRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemOCIReportingModifyACLEntryRequest
extends Request<DefaultResponse>

Modify the description on an entry in the OCI Reporting Access Control List. 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 Optional<@Size(min=1,max=80) String>	description
protected @NotNull @Size(min=1,max=80) String	netAddress
protected Boolean	restrictMessages

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

log

Constructor Summary

Constructors

Constructor	Description
SystemOCIReportingModifyACLEntryRequest()
SystemOCIReportingModifyACLEntryRequest(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.SystemOCIReportingModifyACLEntryRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getNetAddress()
Boolean	getRestrictMessages()
BWSystem.SystemOCIReportingModifyACLEntryRequest	setDescription(String description)
BWSystem.SystemOCIReportingModifyACLEntryRequest	setNetAddress(String netAddress)
BWSystem.SystemOCIReportingModifyACLEntryRequest	setRestrictMessages(Boolean restrictMessages)
BWSystem.SystemOCIReportingModifyACLEntryRequest	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=80)
protected @NotNull @Size(min=1,max=80) String netAddress

description

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

restrictMessages

protected Boolean restrictMessages

Constructor Details

SystemOCIReportingModifyACLEntryRequest

public SystemOCIReportingModifyACLEntryRequest()

SystemOCIReportingModifyACLEntryRequest

public SystemOCIReportingModifyACLEntryRequest(BroadWorksServer broadWorksServer,
 String netAddress)

Method Details

setNetAddress

public BWSystem.SystemOCIReportingModifyACLEntryRequest setNetAddress(String netAddress)

getNetAddress

public String getNetAddress()

unsetDescription

public BWSystem.SystemOCIReportingModifyACLEntryRequest unsetDescription()

setDescription

public BWSystem.SystemOCIReportingModifyACLEntryRequest setDescription(String description)

getDescription

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

setRestrictMessages

public BWSystem.SystemOCIReportingModifyACLEntryRequest setRestrictMessages(Boolean restrictMessages)

getRestrictMessages

public Boolean getRestrictMessages()

getEmptyObject

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