Package co.ecg.alpaca.toolkit.generated

Class FindMeFollowMe.GroupFindMeFollowMeAddAlertingGroupRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.FindMeFollowMe.GroupFindMeFollowMeAddAlertingGroupRequest

Enclosing class:

FindMeFollowMe

@Choice(minOccurs=0,maxOccurs=10,value={@ChoiceGroup("phoneNumber"),@ChoiceGroup("userId")})
public static class FindMeFollowMe.GroupFindMeFollowMeAddAlertingGroupRequest
extends Request<DefaultResponse>

Add an alerting group to a Find-me/Follow-me instance. 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 @Size(min=1,max=80) String	alertingGroupDescription
protected @NotNull @Size(min=1,max=40) String	alertingGroupName
protected @NotNull Boolean	answerConfirmationRequired
protected @NotNull Integer	numberOfRings
protected @Size(max=10) String[]	phoneNumber
protected @NotNull @Size(min=1,max=161) String	serviceUserId
protected @NotNull Boolean	useDiversionInhibitor
protected @Size(max=10) String[]	userId

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

log

Constructor Summary

Constructors

Constructor	Description
GroupFindMeFollowMeAddAlertingGroupRequest()
GroupFindMeFollowMeAddAlertingGroupRequest(BroadWorksServer broadWorksServer, String serviceUserId, String alertingGroupName, Boolean useDiversionInhibitor, Boolean answerConfirmationRequired, Integer numberOfRings)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String	getAlertingGroupDescription()
String	getAlertingGroupName()
Boolean	getAnswerConfirmationRequired()
static FindMeFollowMe.GroupFindMeFollowMeAddAlertingGroupRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Integer	getNumberOfRings()
String[]	getPhoneNumber()
String	getServiceUserId()
Boolean	getUseDiversionInhibitor()
String[]	getUserId()
FindMeFollowMe.GroupFindMeFollowMeAddAlertingGroupRequest	setAlertingGroupDescription(String alertingGroupDescription)
FindMeFollowMe.GroupFindMeFollowMeAddAlertingGroupRequest	setAlertingGroupName(String alertingGroupName)
FindMeFollowMe.GroupFindMeFollowMeAddAlertingGroupRequest	setAnswerConfirmationRequired(Boolean answerConfirmationRequired)
FindMeFollowMe.GroupFindMeFollowMeAddAlertingGroupRequest	setNumberOfRings(Integer numberOfRings)
FindMeFollowMe.GroupFindMeFollowMeAddAlertingGroupRequest	setPhoneNumber(String... phoneNumber)
FindMeFollowMe.GroupFindMeFollowMeAddAlertingGroupRequest	setServiceUserId(String serviceUserId)
FindMeFollowMe.GroupFindMeFollowMeAddAlertingGroupRequest	setUseDiversionInhibitor(Boolean useDiversionInhibitor)
FindMeFollowMe.GroupFindMeFollowMeAddAlertingGroupRequest	setUserId(String... userId)

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

serviceUserId

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

alertingGroupName

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

alertingGroupDescription

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

useDiversionInhibitor

@NotNull
protected @NotNull Boolean useDiversionInhibitor

answerConfirmationRequired

@NotNull
protected @NotNull Boolean answerConfirmationRequired

numberOfRings

@NotNull
protected @NotNull Integer numberOfRings

phoneNumber

@Size(max=10)
@StringArrayElementSize(min=1,
                        max=161)
protected @Size(max=10) String[] phoneNumber

userId

@Size(max=10)
@StringArrayElementSize(min=1,
                        max=161)
protected @Size(max=10) String[] userId

Constructor Details

GroupFindMeFollowMeAddAlertingGroupRequest

public GroupFindMeFollowMeAddAlertingGroupRequest()

GroupFindMeFollowMeAddAlertingGroupRequest

public GroupFindMeFollowMeAddAlertingGroupRequest(BroadWorksServer broadWorksServer,
 String serviceUserId,
 String alertingGroupName,
 Boolean useDiversionInhibitor,
 Boolean answerConfirmationRequired,
 Integer numberOfRings)

Method Details

setServiceUserId

public FindMeFollowMe.GroupFindMeFollowMeAddAlertingGroupRequest setServiceUserId(String serviceUserId)

getServiceUserId

public String getServiceUserId()

setAlertingGroupName

public FindMeFollowMe.GroupFindMeFollowMeAddAlertingGroupRequest setAlertingGroupName(String alertingGroupName)

getAlertingGroupName

public String getAlertingGroupName()

setAlertingGroupDescription

public FindMeFollowMe.GroupFindMeFollowMeAddAlertingGroupRequest setAlertingGroupDescription(String alertingGroupDescription)

getAlertingGroupDescription

public String getAlertingGroupDescription()

setUseDiversionInhibitor

public FindMeFollowMe.GroupFindMeFollowMeAddAlertingGroupRequest setUseDiversionInhibitor(Boolean useDiversionInhibitor)

getUseDiversionInhibitor

public Boolean getUseDiversionInhibitor()

setAnswerConfirmationRequired

public FindMeFollowMe.GroupFindMeFollowMeAddAlertingGroupRequest setAnswerConfirmationRequired(Boolean answerConfirmationRequired)

getAnswerConfirmationRequired

public Boolean getAnswerConfirmationRequired()

setNumberOfRings

public FindMeFollowMe.GroupFindMeFollowMeAddAlertingGroupRequest setNumberOfRings(Integer numberOfRings)

getNumberOfRings

public Integer getNumberOfRings()

setPhoneNumber

public FindMeFollowMe.GroupFindMeFollowMeAddAlertingGroupRequest setPhoneNumber(String... phoneNumber)

getPhoneNumber

public String[] getPhoneNumber()

setUserId

public FindMeFollowMe.GroupFindMeFollowMeAddAlertingGroupRequest setUserId(String... userId)

getUserId

public String[] getUserId()

getEmptyObject

public static FindMeFollowMe.GroupFindMeFollowMeAddAlertingGroupRequest 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>