Package co.ecg.alpaca.toolkit.generated
Class HuntGroup.GroupHuntGroupConsolidatedModifyInstanceRequest
java.lang.Object
co.ecg.alpaca.toolkit.messaging.request.Request<DefaultResponse>
co.ecg.alpaca.toolkit.generated.HuntGroup.GroupHuntGroupConsolidatedModifyInstanceRequest
- Enclosing class:
- HuntGroup
@Choice(minOccurs=0,value={@ChoiceGroup("agentUserIdList"),@ChoiceGroup("agentWeightList")})
public static class HuntGroup.GroupHuntGroupConsolidatedModifyInstanceRequest
extends Request<DefaultResponse>
Request to modify a Hunt Group instance. When phone numbers are un-assigned from the user, the unused numbers may be un-assigned from the group and service provider. If UnassignPhoneNumbersLevel is set to 'Group', the user's primary phone number, fax number and any alternate numbers, will be un-assigned from the group if the command is executed by a service provider administrator or above. When set to 'Service Provider', they will be un-assigned from the group and service provider if the command is executed by a provisioning administrator or above. When omitted, the number(s) will be left assigned to the group. An ErrorResponse will be returned if any number cannot be unassigned because of insufficient privilege. If the phoneNumber has not been assigned to the group and addPhoneNumberToGroup is set to true, it will be added to group if needed if the command is executed by a service provider administrator and above. The command will fail otherwise. The response is either SuccessResponse or ErrorResponse. The following elements are only used in AS data mode: useSystemHuntGroupCLIDSetting includeHuntGroupNameInCLID
- 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 Optional<@Valid ReplacementUserIdList>
protected Optional<@Valid ReplacementAgentWeightList>
protected Boolean
protected Boolean
protected Boolean
protected Optional<@Valid ReplacementUserIdList>
protected Boolean
protected Boolean
protected Boolean
protected Boolean
protected Boolean
protected Integer
protected Boolean
protected Boolean
protected Boolean
protected Boolean
protected @Size(min=1,max=40) String
protected Integer
protected HuntPolicy
protected @Valid ServiceInstanceModifyProfile
protected Optional<@Valid ReplacementConsolidatedUserServiceAssignmentList>
protected UnassignPhoneNumbersLevel
protected @NotNull @Valid HuntGroup
protected Boolean
-
Constructor Summary
ConstructorsConstructorDescription -
Method Summary
Modifier and TypeMethodDescriptionboolean
void
Forms the XML Document for this Request Object.Optional<@Valid ReplacementUserIdList>
Optional<@Valid ReplacementAgentWeightList>
Optional<@Valid ReplacementUserIdList>
getEmptyObject
(BroadWorksServer broadWorksServer) Retrieves this object with minimal setup.setAgentUserIdList
(ReplacementUserIdList agentUserIdList) setAgentWeightList
(ReplacementAgentWeightList agentWeightList) setAllowCallWaitingForAgents
(Boolean allowCallWaitingForAgents) setAllowMembersToControlGroupBusy
(Boolean allowMembersToControlGroupBusy) setApplyGroupBusyWhenTerminatingToAgent
(Boolean applyGroupBusyWhenTerminatingToAgent) setDirectoryNumberHuntingAgentUserIdList
(ReplacementUserIdList directoryNumberHuntingAgentUserIdList) setDirectoryNumberHuntingUseOriginalAgentServicesForBusyAndNoAnswerCalls
(Boolean directoryNumberHuntingUseOriginalAgentServicesForBusyAndNoAnswerCalls) setDirectoryNumberHuntingUseTerminateCallToAgentFirst
(Boolean directoryNumberHuntingUseTerminateCallToAgentFirst) setEnableGroupBusy
(Boolean enableGroupBusy) setEnableNotReachableForwarding
(Boolean enableNotReachableForwarding) setForwardAfterTimeout
(Boolean forwardAfterTimeout) setForwardTimeoutSeconds
(Integer forwardTimeoutSeconds) setForwardToPhoneNumber
(String forwardToPhoneNumber) setHuntAfterNoAnswer
(Boolean huntAfterNoAnswer) setIncludeHuntGroupNameInCLID
(Boolean includeHuntGroupNameInCLID) setIsActive
(Boolean isActive) setMakeBusyWhenNotReachable
(Boolean makeBusyWhenNotReachable) setNetworkClassOfService
(String networkClassOfService) setNoAnswerNumberOfRings
(Integer noAnswerNumberOfRings) setNotReachableForwardToPhoneNumber
(String notReachableForwardToPhoneNumber) setPolicy
(HuntPolicy policy) setServiceInstanceProfile
(ServiceInstanceModifyProfile serviceInstanceProfile) setUnassignPhoneNumbers
(UnassignPhoneNumbersLevel unassignPhoneNumbers) 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
-
user
-
unassignPhoneNumbers
-
addPhoneNumberToGroup
-
serviceInstanceProfile
-
policy
-
huntAfterNoAnswer
-
noAnswerNumberOfRings
-
forwardAfterTimeout
-
forwardTimeoutSeconds
-
forwardToPhoneNumber
-
agentUserIdList
-
agentWeightList
-
allowCallWaitingForAgents
-
useSystemHuntGroupCLIDSetting
-
includeHuntGroupNameInCLID
-
enableNotReachableForwarding
-
notReachableForwardToPhoneNumber
-
makeBusyWhenNotReachable
-
allowMembersToControlGroupBusy
-
enableGroupBusy
-
applyGroupBusyWhenTerminatingToAgent
-
networkClassOfService
-
serviceList
-
isActive
-
directoryNumberHuntingAgentUserIdList
-
directoryNumberHuntingUseTerminateCallToAgentFirst
-
directoryNumberHuntingUseOriginalAgentServicesForBusyAndNoAnswerCalls
-
-
Constructor Details
-
GroupHuntGroupConsolidatedModifyInstanceRequest
public GroupHuntGroupConsolidatedModifyInstanceRequest() -
GroupHuntGroupConsolidatedModifyInstanceRequest
-
-
Method Details
-
setUser
-
getHuntGroup
-
setUnassignPhoneNumbers
public HuntGroup.GroupHuntGroupConsolidatedModifyInstanceRequest setUnassignPhoneNumbers(UnassignPhoneNumbersLevel unassignPhoneNumbers) -
getUnassignPhoneNumbers
-
setFlagAddPhoneNumberToGroup
-
addPhoneNumberToGroupFlagExist
public boolean addPhoneNumberToGroupFlagExist() -
getAddPhoneNumberToGroup
-
setServiceInstanceProfile
public HuntGroup.GroupHuntGroupConsolidatedModifyInstanceRequest setServiceInstanceProfile(ServiceInstanceModifyProfile serviceInstanceProfile) -
getServiceInstanceProfile
-
setPolicy
-
getPolicy
-
setHuntAfterNoAnswer
public HuntGroup.GroupHuntGroupConsolidatedModifyInstanceRequest setHuntAfterNoAnswer(Boolean huntAfterNoAnswer) -
getHuntAfterNoAnswer
-
setNoAnswerNumberOfRings
public HuntGroup.GroupHuntGroupConsolidatedModifyInstanceRequest setNoAnswerNumberOfRings(Integer noAnswerNumberOfRings) -
getNoAnswerNumberOfRings
-
setForwardAfterTimeout
public HuntGroup.GroupHuntGroupConsolidatedModifyInstanceRequest setForwardAfterTimeout(Boolean forwardAfterTimeout) -
getForwardAfterTimeout
-
setForwardTimeoutSeconds
public HuntGroup.GroupHuntGroupConsolidatedModifyInstanceRequest setForwardTimeoutSeconds(Integer forwardTimeoutSeconds) -
getForwardTimeoutSeconds
-
unsetForwardToPhoneNumber
-
setForwardToPhoneNumber
public HuntGroup.GroupHuntGroupConsolidatedModifyInstanceRequest setForwardToPhoneNumber(String forwardToPhoneNumber) -
getForwardToPhoneNumber
-
unsetAgentUserIdList
-
setAgentUserIdList
public HuntGroup.GroupHuntGroupConsolidatedModifyInstanceRequest setAgentUserIdList(ReplacementUserIdList agentUserIdList) -
getAgentUserIdList
-
unsetAgentWeightList
-
setAgentWeightList
public HuntGroup.GroupHuntGroupConsolidatedModifyInstanceRequest setAgentWeightList(ReplacementAgentWeightList agentWeightList) -
getAgentWeightList
-
setAllowCallWaitingForAgents
public HuntGroup.GroupHuntGroupConsolidatedModifyInstanceRequest setAllowCallWaitingForAgents(Boolean allowCallWaitingForAgents) -
getAllowCallWaitingForAgents
-
setUseSystemHuntGroupCLIDSetting
public HuntGroup.GroupHuntGroupConsolidatedModifyInstanceRequest setUseSystemHuntGroupCLIDSetting(Boolean useSystemHuntGroupCLIDSetting) -
getUseSystemHuntGroupCLIDSetting
-
setIncludeHuntGroupNameInCLID
public HuntGroup.GroupHuntGroupConsolidatedModifyInstanceRequest setIncludeHuntGroupNameInCLID(Boolean includeHuntGroupNameInCLID) -
getIncludeHuntGroupNameInCLID
-
setEnableNotReachableForwarding
public HuntGroup.GroupHuntGroupConsolidatedModifyInstanceRequest setEnableNotReachableForwarding(Boolean enableNotReachableForwarding) -
getEnableNotReachableForwarding
-
unsetNotReachableForwardToPhoneNumber
public HuntGroup.GroupHuntGroupConsolidatedModifyInstanceRequest unsetNotReachableForwardToPhoneNumber() -
setNotReachableForwardToPhoneNumber
public HuntGroup.GroupHuntGroupConsolidatedModifyInstanceRequest setNotReachableForwardToPhoneNumber(String notReachableForwardToPhoneNumber) -
getNotReachableForwardToPhoneNumber
-
setMakeBusyWhenNotReachable
public HuntGroup.GroupHuntGroupConsolidatedModifyInstanceRequest setMakeBusyWhenNotReachable(Boolean makeBusyWhenNotReachable) -
getMakeBusyWhenNotReachable
-
setAllowMembersToControlGroupBusy
public HuntGroup.GroupHuntGroupConsolidatedModifyInstanceRequest setAllowMembersToControlGroupBusy(Boolean allowMembersToControlGroupBusy) -
getAllowMembersToControlGroupBusy
-
setEnableGroupBusy
public HuntGroup.GroupHuntGroupConsolidatedModifyInstanceRequest setEnableGroupBusy(Boolean enableGroupBusy) -
getEnableGroupBusy
-
setApplyGroupBusyWhenTerminatingToAgent
public HuntGroup.GroupHuntGroupConsolidatedModifyInstanceRequest setApplyGroupBusyWhenTerminatingToAgent(Boolean applyGroupBusyWhenTerminatingToAgent) -
getApplyGroupBusyWhenTerminatingToAgent
-
setNetworkClassOfService
public HuntGroup.GroupHuntGroupConsolidatedModifyInstanceRequest setNetworkClassOfService(String networkClassOfService) -
getNetworkClassOfService
-
unsetServiceList
-
setServiceList
public HuntGroup.GroupHuntGroupConsolidatedModifyInstanceRequest setServiceList(ReplacementConsolidatedUserServiceAssignmentList serviceList) -
getServiceList
-
setIsActive
-
getIsActive
-
unsetDirectoryNumberHuntingAgentUserIdList
public HuntGroup.GroupHuntGroupConsolidatedModifyInstanceRequest unsetDirectoryNumberHuntingAgentUserIdList() -
setDirectoryNumberHuntingAgentUserIdList
public HuntGroup.GroupHuntGroupConsolidatedModifyInstanceRequest setDirectoryNumberHuntingAgentUserIdList(ReplacementUserIdList directoryNumberHuntingAgentUserIdList) -
getDirectoryNumberHuntingAgentUserIdList
-
setDirectoryNumberHuntingUseTerminateCallToAgentFirst
public HuntGroup.GroupHuntGroupConsolidatedModifyInstanceRequest setDirectoryNumberHuntingUseTerminateCallToAgentFirst(Boolean directoryNumberHuntingUseTerminateCallToAgentFirst) -
getDirectoryNumberHuntingUseTerminateCallToAgentFirst
-
setDirectoryNumberHuntingUseOriginalAgentServicesForBusyAndNoAnswerCalls
public HuntGroup.GroupHuntGroupConsolidatedModifyInstanceRequest setDirectoryNumberHuntingUseOriginalAgentServicesForBusyAndNoAnswerCalls(Boolean directoryNumberHuntingUseOriginalAgentServicesForBusyAndNoAnswerCalls) -
getDirectoryNumberHuntingUseOriginalAgentServicesForBusyAndNoAnswerCalls
-
getEmptyObject
public static HuntGroup.GroupHuntGroupConsolidatedModifyInstanceRequest 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>
-