Package co.ecg.alpaca.toolkit.generated
Class HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest
- java.lang.Object
-
- co.ecg.alpaca.toolkit.messaging.request.Request<DefaultResponse>
-
- co.ecg.alpaca.toolkit.generated.HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest
-
- Enclosing class:
- HuntGroup
@Choice(minOccurs=0,value={@ChoiceGroup("agentUserId"),@ChoiceGroup("agentWeight")}) public static class HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest extends Request<DefaultResponse>
Add a Hunt Group instance to a group. The domain is required in the serviceUserId. If the phoneNumber has not been assigned to the group and addPhoneNumberToGroup is set to true, it will be added to group if the command is executed by a service provider administrator or above and the number is already assigned to the service provider. The command will fail otherwise. The response is either SuccessResponse or ErrorResponse. The following elements are only used in AS data mode: useSystemHuntGroupCLIDSetting, use value "true" in HSS data mode includeHuntGroupNameInCLID, use value "true" in HSS data mode- Author:
- AlpacaGenerator
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class co.ecg.alpaca.toolkit.messaging.request.Request
Request.Protocol
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description GroupHuntGroupConsolidatedAddInstanceRequest()
GroupHuntGroupConsolidatedAddInstanceRequest(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, Boolean isActive)
-
Method Summary
-
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
-
-
-
-
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
-
addPhoneNumberToGroup
@AssertTrue protected @AssertTrue Boolean addPhoneNumberToGroup
-
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
-
agentWeight
@Valid protected @Valid HuntAgentWeight[] agentWeight
-
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
-
service
@Valid protected @Valid ConsolidatedUserServiceAssignment[] service
-
isActive
@NotNull protected @NotNull Boolean isActive
-
directoryNumberHuntingAgentUserIdList
@StringArrayElementSize(min=1, max=161) protected String[] directoryNumberHuntingAgentUserIdList
-
directoryNumberHuntingUseTerminateCallToAgentFirst
protected Boolean directoryNumberHuntingUseTerminateCallToAgentFirst
-
directoryNumberHuntingUseOriginalAgentServicesForBusyAndNoAnswerCalls
protected Boolean directoryNumberHuntingUseOriginalAgentServicesForBusyAndNoAnswerCalls
-
-
Constructor Detail
-
GroupHuntGroupConsolidatedAddInstanceRequest
public GroupHuntGroupConsolidatedAddInstanceRequest()
-
GroupHuntGroupConsolidatedAddInstanceRequest
public GroupHuntGroupConsolidatedAddInstanceRequest(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, Boolean isActive)
-
-
Method Detail
-
setServiceProviderId
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setServiceProviderId(String serviceProviderId)
-
getServiceProviderId
public String getServiceProviderId()
-
setGroupId
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setGroupId(String groupId)
-
getGroupId
public String getGroupId()
-
setServiceUserId
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setServiceUserId(String serviceUserId)
-
getServiceUserId
public String getServiceUserId()
-
setFlagAddPhoneNumberToGroup
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setFlagAddPhoneNumberToGroup()
-
addPhoneNumberToGroupFlagExist
public boolean addPhoneNumberToGroupFlagExist()
-
getAddPhoneNumberToGroup
public Boolean getAddPhoneNumberToGroup()
-
setServiceInstanceProfile
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setServiceInstanceProfile(ServiceInstanceAddProfile serviceInstanceProfile)
-
getServiceInstanceProfile
public ServiceInstanceAddProfile getServiceInstanceProfile()
-
setPolicy
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setPolicy(HuntPolicy policy)
-
getPolicy
public HuntPolicy getPolicy()
-
setHuntAfterNoAnswer
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setHuntAfterNoAnswer(Boolean huntAfterNoAnswer)
-
getHuntAfterNoAnswer
public Boolean getHuntAfterNoAnswer()
-
setNoAnswerNumberOfRings
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setNoAnswerNumberOfRings(Integer noAnswerNumberOfRings)
-
getNoAnswerNumberOfRings
public Integer getNoAnswerNumberOfRings()
-
setForwardAfterTimeout
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setForwardAfterTimeout(Boolean forwardAfterTimeout)
-
getForwardAfterTimeout
public Boolean getForwardAfterTimeout()
-
setForwardTimeoutSeconds
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setForwardTimeoutSeconds(Integer forwardTimeoutSeconds)
-
getForwardTimeoutSeconds
public Integer getForwardTimeoutSeconds()
-
setForwardToPhoneNumber
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setForwardToPhoneNumber(String forwardToPhoneNumber)
-
getForwardToPhoneNumber
public String getForwardToPhoneNumber()
-
setAgentUserId
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setAgentUserId(String... agentUserId)
-
getAgentUserId
public String[] getAgentUserId()
-
setAgentWeight
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setAgentWeight(HuntAgentWeight... agentWeight)
-
getAgentWeight
public HuntAgentWeight[] getAgentWeight()
-
setAllowCallWaitingForAgents
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setAllowCallWaitingForAgents(Boolean allowCallWaitingForAgents)
-
getAllowCallWaitingForAgents
public Boolean getAllowCallWaitingForAgents()
-
setUseSystemHuntGroupCLIDSetting
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setUseSystemHuntGroupCLIDSetting(Boolean useSystemHuntGroupCLIDSetting)
-
getUseSystemHuntGroupCLIDSetting
public Boolean getUseSystemHuntGroupCLIDSetting()
-
setIncludeHuntGroupNameInCLID
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setIncludeHuntGroupNameInCLID(Boolean includeHuntGroupNameInCLID)
-
getIncludeHuntGroupNameInCLID
public Boolean getIncludeHuntGroupNameInCLID()
-
setEnableNotReachableForwarding
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setEnableNotReachableForwarding(Boolean enableNotReachableForwarding)
-
getEnableNotReachableForwarding
public Boolean getEnableNotReachableForwarding()
-
setNotReachableForwardToPhoneNumber
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setNotReachableForwardToPhoneNumber(String notReachableForwardToPhoneNumber)
-
getNotReachableForwardToPhoneNumber
public String getNotReachableForwardToPhoneNumber()
-
setMakeBusyWhenNotReachable
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setMakeBusyWhenNotReachable(Boolean makeBusyWhenNotReachable)
-
getMakeBusyWhenNotReachable
public Boolean getMakeBusyWhenNotReachable()
-
setAllowMembersToControlGroupBusy
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setAllowMembersToControlGroupBusy(Boolean allowMembersToControlGroupBusy)
-
getAllowMembersToControlGroupBusy
public Boolean getAllowMembersToControlGroupBusy()
-
setEnableGroupBusy
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setEnableGroupBusy(Boolean enableGroupBusy)
-
getEnableGroupBusy
public Boolean getEnableGroupBusy()
-
setApplyGroupBusyWhenTerminatingToAgent
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setApplyGroupBusyWhenTerminatingToAgent(Boolean applyGroupBusyWhenTerminatingToAgent)
-
getApplyGroupBusyWhenTerminatingToAgent
public Boolean getApplyGroupBusyWhenTerminatingToAgent()
-
setNetworkClassOfService
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setNetworkClassOfService(String networkClassOfService)
-
getNetworkClassOfService
public String getNetworkClassOfService()
-
setService
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setService(ConsolidatedUserServiceAssignment... service)
-
getService
public ConsolidatedUserServiceAssignment[] getService()
-
setIsActive
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setIsActive(Boolean isActive)
-
getIsActive
public Boolean getIsActive()
-
setDirectoryNumberHuntingAgentUserIdList
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setDirectoryNumberHuntingAgentUserIdList(String... directoryNumberHuntingAgentUserIdList)
-
getDirectoryNumberHuntingAgentUserIdList
public String[] getDirectoryNumberHuntingAgentUserIdList()
-
setDirectoryNumberHuntingUseTerminateCallToAgentFirst
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setDirectoryNumberHuntingUseTerminateCallToAgentFirst(Boolean directoryNumberHuntingUseTerminateCallToAgentFirst)
-
getDirectoryNumberHuntingUseTerminateCallToAgentFirst
public Boolean getDirectoryNumberHuntingUseTerminateCallToAgentFirst()
-
setDirectoryNumberHuntingUseOriginalAgentServicesForBusyAndNoAnswerCalls
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setDirectoryNumberHuntingUseOriginalAgentServicesForBusyAndNoAnswerCalls(Boolean directoryNumberHuntingUseOriginalAgentServicesForBusyAndNoAnswerCalls)
-
getDirectoryNumberHuntingUseOriginalAgentServicesForBusyAndNoAnswerCalls
public Boolean getDirectoryNumberHuntingUseOriginalAgentServicesForBusyAndNoAnswerCalls()
-
getEmptyObject
public static HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest 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 classRequest<DefaultResponse>
-
-