Package co.ecg.alpaca.toolkit.generated

Class ServiceProvider.ServiceProviderOfficeZoneAssignListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.ServiceProvider.ServiceProviderOfficeZoneAssignListRequest

Enclosing class:

ServiceProvider

public static class ServiceProvider.ServiceProviderOfficeZoneAssignListRequest
extends Request<DefaultResponse>

Assign a list of Office Zones to a service provider. The Element defaultOfficeZone is required only for the first assignment, for subsequent assignments it is optional. Office Zones can only be assigned if the Location-Based Calling Restrictions has been authorized to the service provider otherwise the request will fail. 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=40) String	defaultOfficeZoneName
protected String[]	officeZoneName
protected @NotNull @Valid ServiceProvider	serviceProvider

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

log

Constructor Summary

Constructors

Constructor	Description
ServiceProviderOfficeZoneAssignListRequest()
ServiceProviderOfficeZoneAssignListRequest(ServiceProvider serviceProvider)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String	getDefaultOfficeZoneName()
static ServiceProvider.ServiceProviderOfficeZoneAssignListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String[]	getOfficeZoneName()
ServiceProvider	getServiceProvider()
ServiceProvider.ServiceProviderOfficeZoneAssignListRequest	setDefaultOfficeZoneName(String defaultOfficeZoneName)
ServiceProvider.ServiceProviderOfficeZoneAssignListRequest	setOfficeZoneName(String... officeZoneName)
ServiceProvider.ServiceProviderOfficeZoneAssignListRequest	setServiceProvider(ServiceProvider serviceProvider)

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

serviceProvider

@NotNull
@Valid
protected transient @NotNull @Valid ServiceProvider serviceProvider

officeZoneName

@StringArrayElementSize(min=1,
                        max=40)
protected String[] officeZoneName

defaultOfficeZoneName

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

Constructor Details

ServiceProviderOfficeZoneAssignListRequest

public ServiceProviderOfficeZoneAssignListRequest()

ServiceProviderOfficeZoneAssignListRequest

public ServiceProviderOfficeZoneAssignListRequest(ServiceProvider serviceProvider)

Method Details

setServiceProvider

public ServiceProvider.ServiceProviderOfficeZoneAssignListRequest setServiceProvider(ServiceProvider serviceProvider)

getServiceProvider

public ServiceProvider getServiceProvider()

setOfficeZoneName

public ServiceProvider.ServiceProviderOfficeZoneAssignListRequest setOfficeZoneName(String... officeZoneName)

getOfficeZoneName

public String[] getOfficeZoneName()

setDefaultOfficeZoneName

public ServiceProvider.ServiceProviderOfficeZoneAssignListRequest setDefaultOfficeZoneName(String defaultOfficeZoneName)

getDefaultOfficeZoneName

public String getDefaultOfficeZoneName()

getEmptyObject

public static ServiceProvider.ServiceProviderOfficeZoneAssignListRequest 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>