Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemOCIReportingAddACLEntryRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemOCIReportingAddACLEntryRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemOCIReportingAddACLEntryRequest
extends Request<DefaultResponse>

Add an entry to 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 @Size(min=1,max=80) String	description
protected @NotNull @Size(min=1,max=80) String	netAddress
protected @NotNull Boolean	restrictMessages

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

log

Constructor Summary

Constructors

Constructor	Description
SystemOCIReportingAddACLEntryRequest()
SystemOCIReportingAddACLEntryRequest(BroadWorksServer broadWorksServer, String netAddress, Boolean restrictMessages)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String	getDescription()
static BWSystem.SystemOCIReportingAddACLEntryRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getNetAddress()
Boolean	getRestrictMessages()
BWSystem.SystemOCIReportingAddACLEntryRequest	setDescription(String description)
BWSystem.SystemOCIReportingAddACLEntryRequest	setNetAddress(String netAddress)
BWSystem.SystemOCIReportingAddACLEntryRequest	setRestrictMessages(Boolean restrictMessages)

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

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

restrictMessages

@NotNull
protected @NotNull Boolean restrictMessages

Constructor Details

SystemOCIReportingAddACLEntryRequest

public SystemOCIReportingAddACLEntryRequest()

SystemOCIReportingAddACLEntryRequest

public SystemOCIReportingAddACLEntryRequest(BroadWorksServer broadWorksServer,
 String netAddress,
 Boolean restrictMessages)

Method Details

setNetAddress

public BWSystem.SystemOCIReportingAddACLEntryRequest setNetAddress(String netAddress)

getNetAddress

public String getNetAddress()

setDescription

public BWSystem.SystemOCIReportingAddACLEntryRequest setDescription(String description)

getDescription

public String getDescription()

setRestrictMessages

public BWSystem.SystemOCIReportingAddACLEntryRequest setRestrictMessages(Boolean restrictMessages)

getRestrictMessages

public Boolean getRestrictMessages()

getEmptyObject

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