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 weight element inside the agentWeight element will only take effect if the policy element is set to "Weighted" in the request. 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
FieldsModifier and TypeFieldDescriptionprotected @AssertTrue Boolean
protected String[]
protected @Valid HuntAgentWeight[]
protected @NotNull Boolean
protected @NotNull Boolean
protected @NotNull Boolean
protected String[]
protected Boolean
protected Boolean
protected @NotNull Boolean
protected @NotNull Boolean
protected @NotNull Boolean
protected @NotNull Integer
protected @Size(min=1,max=30) String
protected @NotNull @Size(min=1,max=30) String
protected @NotNull Boolean
protected @NotNull Boolean
protected @NotNull Boolean
protected @NotNull Boolean
protected @Size(min=1,max=40) String
protected @NotNull Integer
protected @Size(min=1,max=161) String
protected @NotNull HuntPolicy
protected @Valid ConsolidatedUserServiceAssignment[]
protected @NotNull @Valid ServiceInstanceAddProfile
protected @NotNull @Size(min=1,max=30) String
protected @NotNull @Size(min=1,max=161) String
protected @NotNull Boolean
-
Constructor Summary
ConstructorsConstructorDescriptionGroupHuntGroupConsolidatedAddInstanceRequest
(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
Modifier and TypeMethodDescriptionboolean
void
Forms the XML Document for this Request Object.String[]
String[]
getEmptyObject
(BroadWorksServer broadWorksServer) Retrieves this object with minimal setup.setAgentUserId
(String... agentUserId) setAgentWeight
(HuntAgentWeight... agentWeight) setAllowCallWaitingForAgents
(Boolean allowCallWaitingForAgents) setAllowMembersToControlGroupBusy
(Boolean allowMembersToControlGroupBusy) setApplyGroupBusyWhenTerminatingToAgent
(Boolean applyGroupBusyWhenTerminatingToAgent) setDirectoryNumberHuntingAgentUserIdList
(String... directoryNumberHuntingAgentUserIdList) setDirectoryNumberHuntingUseOriginalAgentServicesForBusyAndNoAnswerCalls
(Boolean directoryNumberHuntingUseOriginalAgentServicesForBusyAndNoAnswerCalls) setDirectoryNumberHuntingUseTerminateCallToAgentFirst
(Boolean directoryNumberHuntingUseTerminateCallToAgentFirst) setEnableGroupBusy
(Boolean enableGroupBusy) setEnableNotReachableForwarding
(Boolean enableNotReachableForwarding) setForwardAfterTimeout
(Boolean forwardAfterTimeout) setForwardTimeoutSeconds
(Integer forwardTimeoutSeconds) setForwardToPhoneNumber
(String forwardToPhoneNumber) setGroupId
(String groupId) setHuntAfterNoAnswer
(Boolean huntAfterNoAnswer) setIncludeHuntGroupNameInCLID
(Boolean includeHuntGroupNameInCLID) setIsActive
(Boolean isActive) setMakeBusyWhenNotReachable
(Boolean makeBusyWhenNotReachable) setNetworkClassOfService
(String networkClassOfService) setNoAnswerNumberOfRings
(Integer noAnswerNumberOfRings) setNotReachableForwardToPhoneNumber
(String notReachableForwardToPhoneNumber) setPolicy
(HuntPolicy policy) setService
(ConsolidatedUserServiceAssignment... service) setServiceInstanceProfile
(ServiceInstanceAddProfile serviceInstanceProfile) setServiceProviderId
(String serviceProviderId) setServiceUserId
(String serviceUserId) 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
-
Field Details
-
serviceProviderId
-
groupId
-
serviceUserId
-
addPhoneNumberToGroup
-
serviceInstanceProfile
-
policy
-
huntAfterNoAnswer
-
noAnswerNumberOfRings
-
forwardAfterTimeout
-
forwardTimeoutSeconds
-
forwardToPhoneNumber
-
agentUserId
-
agentWeight
-
allowCallWaitingForAgents
-
useSystemHuntGroupCLIDSetting
-
includeHuntGroupNameInCLID
-
enableNotReachableForwarding
-
notReachableForwardToPhoneNumber
-
makeBusyWhenNotReachable
-
allowMembersToControlGroupBusy
-
enableGroupBusy
-
applyGroupBusyWhenTerminatingToAgent
-
networkClassOfService
-
service
-
isActive
-
directoryNumberHuntingAgentUserIdList
-
directoryNumberHuntingUseTerminateCallToAgentFirst
-
directoryNumberHuntingUseOriginalAgentServicesForBusyAndNoAnswerCalls
-
-
Constructor Details
-
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 Details
-
setServiceProviderId
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setServiceProviderId(String serviceProviderId) -
getServiceProviderId
-
setGroupId
-
getGroupId
-
setServiceUserId
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setServiceUserId(String serviceUserId) -
getServiceUserId
-
setFlagAddPhoneNumberToGroup
-
addPhoneNumberToGroupFlagExist
public boolean addPhoneNumberToGroupFlagExist() -
getAddPhoneNumberToGroup
-
setServiceInstanceProfile
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setServiceInstanceProfile(ServiceInstanceAddProfile serviceInstanceProfile) -
getServiceInstanceProfile
-
setPolicy
-
getPolicy
-
setHuntAfterNoAnswer
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setHuntAfterNoAnswer(Boolean huntAfterNoAnswer) -
getHuntAfterNoAnswer
-
setNoAnswerNumberOfRings
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setNoAnswerNumberOfRings(Integer noAnswerNumberOfRings) -
getNoAnswerNumberOfRings
-
setForwardAfterTimeout
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setForwardAfterTimeout(Boolean forwardAfterTimeout) -
getForwardAfterTimeout
-
setForwardTimeoutSeconds
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setForwardTimeoutSeconds(Integer forwardTimeoutSeconds) -
getForwardTimeoutSeconds
-
setForwardToPhoneNumber
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setForwardToPhoneNumber(String forwardToPhoneNumber) -
getForwardToPhoneNumber
-
setAgentUserId
-
getAgentUserId
-
setAgentWeight
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setAgentWeight(HuntAgentWeight... agentWeight) -
getAgentWeight
-
setAllowCallWaitingForAgents
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setAllowCallWaitingForAgents(Boolean allowCallWaitingForAgents) -
getAllowCallWaitingForAgents
-
setUseSystemHuntGroupCLIDSetting
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setUseSystemHuntGroupCLIDSetting(Boolean useSystemHuntGroupCLIDSetting) -
getUseSystemHuntGroupCLIDSetting
-
setIncludeHuntGroupNameInCLID
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setIncludeHuntGroupNameInCLID(Boolean includeHuntGroupNameInCLID) -
getIncludeHuntGroupNameInCLID
-
setEnableNotReachableForwarding
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setEnableNotReachableForwarding(Boolean enableNotReachableForwarding) -
getEnableNotReachableForwarding
-
setNotReachableForwardToPhoneNumber
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setNotReachableForwardToPhoneNumber(String notReachableForwardToPhoneNumber) -
getNotReachableForwardToPhoneNumber
-
setMakeBusyWhenNotReachable
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setMakeBusyWhenNotReachable(Boolean makeBusyWhenNotReachable) -
getMakeBusyWhenNotReachable
-
setAllowMembersToControlGroupBusy
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setAllowMembersToControlGroupBusy(Boolean allowMembersToControlGroupBusy) -
getAllowMembersToControlGroupBusy
-
setEnableGroupBusy
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setEnableGroupBusy(Boolean enableGroupBusy) -
getEnableGroupBusy
-
setApplyGroupBusyWhenTerminatingToAgent
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setApplyGroupBusyWhenTerminatingToAgent(Boolean applyGroupBusyWhenTerminatingToAgent) -
getApplyGroupBusyWhenTerminatingToAgent
-
setNetworkClassOfService
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setNetworkClassOfService(String networkClassOfService) -
getNetworkClassOfService
-
setService
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setService(ConsolidatedUserServiceAssignment... service) -
getService
-
setIsActive
-
getIsActive
-
setDirectoryNumberHuntingAgentUserIdList
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setDirectoryNumberHuntingAgentUserIdList(String... directoryNumberHuntingAgentUserIdList) -
getDirectoryNumberHuntingAgentUserIdList
-
setDirectoryNumberHuntingUseTerminateCallToAgentFirst
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setDirectoryNumberHuntingUseTerminateCallToAgentFirst(Boolean directoryNumberHuntingUseTerminateCallToAgentFirst) -
getDirectoryNumberHuntingUseTerminateCallToAgentFirst
-
setDirectoryNumberHuntingUseOriginalAgentServicesForBusyAndNoAnswerCalls
public HuntGroup.GroupHuntGroupConsolidatedAddInstanceRequest setDirectoryNumberHuntingUseOriginalAgentServicesForBusyAndNoAnswerCalls(Boolean directoryNumberHuntingUseOriginalAgentServicesForBusyAndNoAnswerCalls) -
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>
-