Package co.ecg.alpaca.toolkit.generated

Class VoiceXml.GroupVoiceXmlAddInstanceRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.VoiceXml.GroupVoiceXmlAddInstanceRequest

Enclosing class:

VoiceXml

public static class VoiceXml.GroupVoiceXmlAddInstanceRequest
extends Request<DefaultResponse>

Add a VoiceXML instance to a group. The domain is required in the serviceUserId. For a valid voiceXml instance to work properly, a device with Static Registration is expected with a valid contact. 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 @Valid AccessDeviceEndpointAdd	accessDeviceEndpoint
protected @NotNull @Size(min=1,max=30) String	groupId
protected @Size(min=1,max=40) String	networkClassOfService
protected @NotNull @Valid ServiceInstanceAddProfile	serviceInstanceProfile
protected @NotNull @Size(min=1,max=30) String	serviceProviderId
protected @NotNull @Size(min=1,max=161) String	serviceUserId

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

log

Constructor Summary

Constructors

Constructor	Description
GroupVoiceXmlAddInstanceRequest()
GroupVoiceXmlAddInstanceRequest(BroadWorksServer broadWorksServer, String serviceProviderId, String groupId, String serviceUserId, ServiceInstanceAddProfile serviceInstanceProfile)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
AccessDeviceEndpointAdd	getAccessDeviceEndpoint()
static VoiceXml.GroupVoiceXmlAddInstanceRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getGroupId()
String	getNetworkClassOfService()
ServiceInstanceAddProfile	getServiceInstanceProfile()
String	getServiceProviderId()
String	getServiceUserId()
VoiceXml.GroupVoiceXmlAddInstanceRequest	setAccessDeviceEndpoint(AccessDeviceEndpointAdd accessDeviceEndpoint)
VoiceXml.GroupVoiceXmlAddInstanceRequest	setGroupId(String groupId)
VoiceXml.GroupVoiceXmlAddInstanceRequest	setNetworkClassOfService(String networkClassOfService)
VoiceXml.GroupVoiceXmlAddInstanceRequest	setServiceInstanceProfile(ServiceInstanceAddProfile serviceInstanceProfile)
VoiceXml.GroupVoiceXmlAddInstanceRequest	setServiceProviderId(String serviceProviderId)
VoiceXml.GroupVoiceXmlAddInstanceRequest	setServiceUserId(String serviceUserId)

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

serviceProviderId

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

groupId

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

serviceUserId

@NotNull
@Size(min=1,
      max=161)
protected @NotNull @Size(min=1,max=161) String serviceUserId

serviceInstanceProfile

@NotNull
@Valid
protected @NotNull @Valid ServiceInstanceAddProfile serviceInstanceProfile

networkClassOfService

@Size(min=1,
      max=40)
protected @Size(min=1,max=40) String networkClassOfService

accessDeviceEndpoint

@Valid
protected @Valid AccessDeviceEndpointAdd accessDeviceEndpoint

Constructor Details

GroupVoiceXmlAddInstanceRequest

public GroupVoiceXmlAddInstanceRequest()

GroupVoiceXmlAddInstanceRequest

public GroupVoiceXmlAddInstanceRequest(BroadWorksServer broadWorksServer,
 String serviceProviderId,
 String groupId,
 String serviceUserId,
 ServiceInstanceAddProfile serviceInstanceProfile)

Method Details

setServiceProviderId

public VoiceXml.GroupVoiceXmlAddInstanceRequest setServiceProviderId(String serviceProviderId)

getServiceProviderId

public String getServiceProviderId()

setGroupId

public VoiceXml.GroupVoiceXmlAddInstanceRequest setGroupId(String groupId)

getGroupId

public String getGroupId()

setServiceUserId

public VoiceXml.GroupVoiceXmlAddInstanceRequest setServiceUserId(String serviceUserId)

getServiceUserId

public String getServiceUserId()

setServiceInstanceProfile

public VoiceXml.GroupVoiceXmlAddInstanceRequest setServiceInstanceProfile(ServiceInstanceAddProfile serviceInstanceProfile)

getServiceInstanceProfile

public ServiceInstanceAddProfile getServiceInstanceProfile()

setNetworkClassOfService

public VoiceXml.GroupVoiceXmlAddInstanceRequest setNetworkClassOfService(String networkClassOfService)

getNetworkClassOfService

public String getNetworkClassOfService()

setAccessDeviceEndpoint

public VoiceXml.GroupVoiceXmlAddInstanceRequest setAccessDeviceEndpoint(AccessDeviceEndpointAdd accessDeviceEndpoint)

getAccessDeviceEndpoint

public AccessDeviceEndpointAdd getAccessDeviceEndpoint()

getEmptyObject

public static VoiceXml.GroupVoiceXmlAddInstanceRequest 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>