Package co.ecg.alpaca.toolkit.generated

Class HuntGroup.GroupHuntGroupAddInstanceRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.HuntGroup.GroupHuntGroupAddInstanceRequest

Enclosing class:

HuntGroup

public static class HuntGroup.GroupHuntGroupAddInstanceRequest
extends Request<DefaultResponse>

Add a Hunt Group instance to a group. The domain is required in the serviceUserId. The response is either SuccessResponse or ErrorResponse. The following elements are only used in AS data mode: useSystemHuntGroupCLIDSetting, use value "true" in XS data mode includeHuntGroupNameInCLID, use value "true" in XS data mode

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 String[]	agentUserId
protected @NotNull Boolean	allowCallWaitingForAgents
protected @NotNull Boolean	allowMembersToControlGroupBusy
protected @NotNull Boolean	applyGroupBusyWhenTerminatingToAgent
protected @NotNull Boolean	enableGroupBusy
protected @NotNull Boolean	enableNotReachableForwarding
protected @NotNull Boolean	forwardAfterTimeout
protected @NotNull Integer	forwardTimeoutSeconds
protected @Size(min=1,max=30) String	forwardToPhoneNumber
protected @NotNull @Size(min=1,max=30) String	groupId
protected @NotNull Boolean	huntAfterNoAnswer
protected @NotNull Boolean	includeHuntGroupNameInCLID
protected @NotNull Boolean	makeBusyWhenNotReachable
protected @Size(min=1,max=40) String	networkClassOfService
protected @NotNull Integer	noAnswerNumberOfRings
protected @Size(min=1,max=161) String	notReachableForwardToPhoneNumber
protected @NotNull HuntPolicy	policy
protected @NotNull @Valid ServiceInstanceAddProfile	serviceInstanceProfile
protected @NotNull @Size(min=1,max=30) String	serviceProviderId
protected @NotNull @Size(min=1,max=161) String	serviceUserId
protected @NotNull Boolean	useSystemHuntGroupCLIDSetting

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

log

Constructor Summary

Constructors

Constructor	Description
GroupHuntGroupAddInstanceRequest()
GroupHuntGroupAddInstanceRequest(BroadWorksServer broadWorksServer, String serviceProviderId, String groupId, String serviceUserId, ServiceInstanceAddProfile serviceInstanceProfile, HuntPolicy policy, Boolean huntAfterNoAnswer, Integer noAnswerNumberOfRings, Boolean forwardAfterTimeout, Integer forwardTimeoutSeconds, Boolean allowCallWaitingForAgents, Boolean useSystemHuntGroupCLIDSetting, Boolean includeHuntGroupNameInCLID, Boolean enableNotReachableForwarding, Boolean makeBusyWhenNotReachable, Boolean allowMembersToControlGroupBusy, Boolean enableGroupBusy, Boolean applyGroupBusyWhenTerminatingToAgent)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String[]	getAgentUserId()
Boolean	getAllowCallWaitingForAgents()
Boolean	getAllowMembersToControlGroupBusy()
Boolean	getApplyGroupBusyWhenTerminatingToAgent()
static HuntGroup.GroupHuntGroupAddInstanceRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Boolean	getEnableGroupBusy()
Boolean	getEnableNotReachableForwarding()
Boolean	getForwardAfterTimeout()
Integer	getForwardTimeoutSeconds()
String	getForwardToPhoneNumber()
String	getGroupId()
Boolean	getHuntAfterNoAnswer()
Boolean	getIncludeHuntGroupNameInCLID()
Boolean	getMakeBusyWhenNotReachable()
String	getNetworkClassOfService()
Integer	getNoAnswerNumberOfRings()
String	getNotReachableForwardToPhoneNumber()
HuntPolicy	getPolicy()
ServiceInstanceAddProfile	getServiceInstanceProfile()
String	getServiceProviderId()
String	getServiceUserId()
Boolean	getUseSystemHuntGroupCLIDSetting()
HuntGroup.GroupHuntGroupAddInstanceRequest	setAgentUserId(String... agentUserId)
HuntGroup.GroupHuntGroupAddInstanceRequest	setAllowCallWaitingForAgents(Boolean allowCallWaitingForAgents)
HuntGroup.GroupHuntGroupAddInstanceRequest	setAllowMembersToControlGroupBusy(Boolean allowMembersToControlGroupBusy)
HuntGroup.GroupHuntGroupAddInstanceRequest	setApplyGroupBusyWhenTerminatingToAgent(Boolean applyGroupBusyWhenTerminatingToAgent)
HuntGroup.GroupHuntGroupAddInstanceRequest	setEnableGroupBusy(Boolean enableGroupBusy)
HuntGroup.GroupHuntGroupAddInstanceRequest	setEnableNotReachableForwarding(Boolean enableNotReachableForwarding)
HuntGroup.GroupHuntGroupAddInstanceRequest	setForwardAfterTimeout(Boolean forwardAfterTimeout)
HuntGroup.GroupHuntGroupAddInstanceRequest	setForwardTimeoutSeconds(Integer forwardTimeoutSeconds)
HuntGroup.GroupHuntGroupAddInstanceRequest	setForwardToPhoneNumber(String forwardToPhoneNumber)
HuntGroup.GroupHuntGroupAddInstanceRequest	setGroupId(String groupId)
HuntGroup.GroupHuntGroupAddInstanceRequest	setHuntAfterNoAnswer(Boolean huntAfterNoAnswer)
HuntGroup.GroupHuntGroupAddInstanceRequest	setIncludeHuntGroupNameInCLID(Boolean includeHuntGroupNameInCLID)
HuntGroup.GroupHuntGroupAddInstanceRequest	setMakeBusyWhenNotReachable(Boolean makeBusyWhenNotReachable)
HuntGroup.GroupHuntGroupAddInstanceRequest	setNetworkClassOfService(String networkClassOfService)
HuntGroup.GroupHuntGroupAddInstanceRequest	setNoAnswerNumberOfRings(Integer noAnswerNumberOfRings)
HuntGroup.GroupHuntGroupAddInstanceRequest	setNotReachableForwardToPhoneNumber(String notReachableForwardToPhoneNumber)
HuntGroup.GroupHuntGroupAddInstanceRequest	setPolicy(HuntPolicy policy)
HuntGroup.GroupHuntGroupAddInstanceRequest	setServiceInstanceProfile(ServiceInstanceAddProfile serviceInstanceProfile)
HuntGroup.GroupHuntGroupAddInstanceRequest	setServiceProviderId(String serviceProviderId)
HuntGroup.GroupHuntGroupAddInstanceRequest	setServiceUserId(String serviceUserId)
HuntGroup.GroupHuntGroupAddInstanceRequest	setUseSystemHuntGroupCLIDSetting(Boolean useSystemHuntGroupCLIDSetting)

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 Detail

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

policy

@NotNull
protected @NotNull HuntPolicy policy

huntAfterNoAnswer

@NotNull
protected @NotNull Boolean huntAfterNoAnswer

noAnswerNumberOfRings

@NotNull
protected @NotNull Integer noAnswerNumberOfRings

forwardAfterTimeout

@NotNull
protected @NotNull Boolean forwardAfterTimeout

forwardTimeoutSeconds

@NotNull
protected @NotNull Integer forwardTimeoutSeconds

forwardToPhoneNumber

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

agentUserId

@StringArrayElementSize(min=1,
                        max=161)
protected String[] agentUserId

allowCallWaitingForAgents

@NotNull
protected @NotNull Boolean allowCallWaitingForAgents

useSystemHuntGroupCLIDSetting

@NotNull
protected @NotNull Boolean useSystemHuntGroupCLIDSetting

includeHuntGroupNameInCLID

@NotNull
protected @NotNull Boolean includeHuntGroupNameInCLID

enableNotReachableForwarding

@NotNull
protected @NotNull Boolean enableNotReachableForwarding

notReachableForwardToPhoneNumber

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

makeBusyWhenNotReachable

@NotNull
protected @NotNull Boolean makeBusyWhenNotReachable

allowMembersToControlGroupBusy

@NotNull
protected @NotNull Boolean allowMembersToControlGroupBusy

enableGroupBusy

@NotNull
protected @NotNull Boolean enableGroupBusy

applyGroupBusyWhenTerminatingToAgent

@NotNull
protected @NotNull Boolean applyGroupBusyWhenTerminatingToAgent

networkClassOfService

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

Constructor Detail

GroupHuntGroupAddInstanceRequest

public GroupHuntGroupAddInstanceRequest()

GroupHuntGroupAddInstanceRequest

public GroupHuntGroupAddInstanceRequest(BroadWorksServer broadWorksServer,
                                        String serviceProviderId,
                                        String groupId,
                                        String serviceUserId,
                                        ServiceInstanceAddProfile serviceInstanceProfile,
                                        HuntPolicy policy,
                                        Boolean huntAfterNoAnswer,
                                        Integer noAnswerNumberOfRings,
                                        Boolean forwardAfterTimeout,
                                        Integer forwardTimeoutSeconds,
                                        Boolean allowCallWaitingForAgents,
                                        Boolean useSystemHuntGroupCLIDSetting,
                                        Boolean includeHuntGroupNameInCLID,
                                        Boolean enableNotReachableForwarding,
                                        Boolean makeBusyWhenNotReachable,
                                        Boolean allowMembersToControlGroupBusy,
                                        Boolean enableGroupBusy,
                                        Boolean applyGroupBusyWhenTerminatingToAgent)

Method Detail

setServiceProviderId

public HuntGroup.GroupHuntGroupAddInstanceRequest setServiceProviderId(String serviceProviderId)

getServiceProviderId

public String getServiceProviderId()

setGroupId

public HuntGroup.GroupHuntGroupAddInstanceRequest setGroupId(String groupId)

getGroupId

public String getGroupId()

setServiceUserId

public HuntGroup.GroupHuntGroupAddInstanceRequest setServiceUserId(String serviceUserId)

getServiceUserId

public String getServiceUserId()

setServiceInstanceProfile

public HuntGroup.GroupHuntGroupAddInstanceRequest setServiceInstanceProfile(ServiceInstanceAddProfile serviceInstanceProfile)

getServiceInstanceProfile

public ServiceInstanceAddProfile getServiceInstanceProfile()

setPolicy

public HuntGroup.GroupHuntGroupAddInstanceRequest setPolicy(HuntPolicy policy)

getPolicy

public HuntPolicy getPolicy()

setHuntAfterNoAnswer

public HuntGroup.GroupHuntGroupAddInstanceRequest setHuntAfterNoAnswer(Boolean huntAfterNoAnswer)

getHuntAfterNoAnswer

public Boolean getHuntAfterNoAnswer()

setNoAnswerNumberOfRings

public HuntGroup.GroupHuntGroupAddInstanceRequest setNoAnswerNumberOfRings(Integer noAnswerNumberOfRings)

getNoAnswerNumberOfRings

public Integer getNoAnswerNumberOfRings()

setForwardAfterTimeout

public HuntGroup.GroupHuntGroupAddInstanceRequest setForwardAfterTimeout(Boolean forwardAfterTimeout)

getForwardAfterTimeout

public Boolean getForwardAfterTimeout()

setForwardTimeoutSeconds

public HuntGroup.GroupHuntGroupAddInstanceRequest setForwardTimeoutSeconds(Integer forwardTimeoutSeconds)

getForwardTimeoutSeconds

public Integer getForwardTimeoutSeconds()

setForwardToPhoneNumber

public HuntGroup.GroupHuntGroupAddInstanceRequest setForwardToPhoneNumber(String forwardToPhoneNumber)

getForwardToPhoneNumber

public String getForwardToPhoneNumber()

setAgentUserId

public HuntGroup.GroupHuntGroupAddInstanceRequest setAgentUserId(String... agentUserId)

getAgentUserId

public String[] getAgentUserId()

setAllowCallWaitingForAgents

public HuntGroup.GroupHuntGroupAddInstanceRequest setAllowCallWaitingForAgents(Boolean allowCallWaitingForAgents)

getAllowCallWaitingForAgents

public Boolean getAllowCallWaitingForAgents()

setUseSystemHuntGroupCLIDSetting

public HuntGroup.GroupHuntGroupAddInstanceRequest setUseSystemHuntGroupCLIDSetting(Boolean useSystemHuntGroupCLIDSetting)

getUseSystemHuntGroupCLIDSetting

public Boolean getUseSystemHuntGroupCLIDSetting()

setIncludeHuntGroupNameInCLID

public HuntGroup.GroupHuntGroupAddInstanceRequest setIncludeHuntGroupNameInCLID(Boolean includeHuntGroupNameInCLID)

getIncludeHuntGroupNameInCLID

public Boolean getIncludeHuntGroupNameInCLID()

setEnableNotReachableForwarding

public HuntGroup.GroupHuntGroupAddInstanceRequest setEnableNotReachableForwarding(Boolean enableNotReachableForwarding)

getEnableNotReachableForwarding

public Boolean getEnableNotReachableForwarding()

setNotReachableForwardToPhoneNumber

public HuntGroup.GroupHuntGroupAddInstanceRequest setNotReachableForwardToPhoneNumber(String notReachableForwardToPhoneNumber)

getNotReachableForwardToPhoneNumber

public String getNotReachableForwardToPhoneNumber()

setMakeBusyWhenNotReachable

public HuntGroup.GroupHuntGroupAddInstanceRequest setMakeBusyWhenNotReachable(Boolean makeBusyWhenNotReachable)

getMakeBusyWhenNotReachable

public Boolean getMakeBusyWhenNotReachable()

setAllowMembersToControlGroupBusy

public HuntGroup.GroupHuntGroupAddInstanceRequest setAllowMembersToControlGroupBusy(Boolean allowMembersToControlGroupBusy)

getAllowMembersToControlGroupBusy

public Boolean getAllowMembersToControlGroupBusy()

setEnableGroupBusy

public HuntGroup.GroupHuntGroupAddInstanceRequest setEnableGroupBusy(Boolean enableGroupBusy)

getEnableGroupBusy

public Boolean getEnableGroupBusy()

setApplyGroupBusyWhenTerminatingToAgent

public HuntGroup.GroupHuntGroupAddInstanceRequest setApplyGroupBusyWhenTerminatingToAgent(Boolean applyGroupBusyWhenTerminatingToAgent)

getApplyGroupBusyWhenTerminatingToAgent

public Boolean getApplyGroupBusyWhenTerminatingToAgent()

setNetworkClassOfService

public HuntGroup.GroupHuntGroupAddInstanceRequest setNetworkClassOfService(String networkClassOfService)

getNetworkClassOfService

public String getNetworkClassOfService()

getEmptyObject

public static HuntGroup.GroupHuntGroupAddInstanceRequest 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>