Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemServiceCodeAddRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemServiceCodeAddRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemServiceCodeAddRequest
extends Request<DefaultResponse>

Request to add a service code for the purpose of providing free format routable strings for dialing 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 @NotNull @Size(min=1,max=200) String	description
protected @NotNull @Size(min=1,max=30) String	serviceCode

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

log

Constructor Summary

Constructors

Constructor	Description
SystemServiceCodeAddRequest()
SystemServiceCodeAddRequest(BroadWorksServer broadWorksServer, String serviceCode, String description)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String	getDescription()
static BWSystem.SystemServiceCodeAddRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getServiceCode()
BWSystem.SystemServiceCodeAddRequest	setDescription(String description)
BWSystem.SystemServiceCodeAddRequest	setServiceCode(String serviceCode)

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, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setEcho, 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

serviceCode

@NotNull
@Size(min=1,
      max=30)
protected @NotNull @Size(min=1,max=30) String serviceCode

description

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

Constructor Detail

SystemServiceCodeAddRequest

public SystemServiceCodeAddRequest()

SystemServiceCodeAddRequest

public SystemServiceCodeAddRequest(BroadWorksServer broadWorksServer,
                                   String serviceCode,
                                   String description)

Method Detail

setServiceCode

public BWSystem.SystemServiceCodeAddRequest setServiceCode(String serviceCode)

getServiceCode

public String getServiceCode()

setDescription

public BWSystem.SystemServiceCodeAddRequest setDescription(String description)

getDescription

public String getDescription()

getEmptyObject

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