Package co.ecg.alpaca.toolkit.generated
Class CollaborateBridge.GroupCollaborateBridgeConsolidatedModifyInstanceRequest
java.lang.Object
co.ecg.alpaca.toolkit.messaging.request.Request<DefaultResponse>
co.ecg.alpaca.toolkit.generated.CollaborateBridge.GroupCollaborateBridgeConsolidatedModifyInstanceRequest
- Enclosing class:
CollaborateBridge
public static class CollaborateBridge.GroupCollaborateBridgeConsolidatedModifyInstanceRequest
extends Request<DefaultResponse>
Request to modify a Collaborate bridge. The request fails when the collaborateOwnerUserIdList is included in the request for the default collaborate bridge. The request fails when the supportOutdial is included in the request and the system-level collaborate supportOutdial setting is disabled. 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.
- 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 Booleanprotected Optional<@Valid ReplacementUserIdList> protected Integerprotected @Valid CollaborateBridgeMaximumParticipantsprotected @Size(min=1,max=40) Stringprotected @Valid ServiceInstanceModifyProfileprotected Optional<@Valid ReplacementConsolidatedUserServiceAssignmentList> protected Booleanprotected UnassignPhoneNumbersLevelprotected @NotNull @Valid CollaborateBridge -
Constructor Summary
ConstructorsConstructorDescription -
Method Summary
Modifier and TypeMethodDescriptionbooleanvoidForms the XML Document for this Request Object.Optional<@Valid ReplacementUserIdList> getEmptyObject(BroadWorksServer broadWorksServer) Retrieves this object with minimal setup.setCollaborateOwnerUserIdList(ReplacementUserIdList collaborateOwnerUserIdList) setMaxCollaborateRoomParticipants(Integer maxCollaborateRoomParticipants) setMaximumBridgeParticipants(CollaborateBridgeMaximumParticipants maximumBridgeParticipants) setNetworkClassOfService(String networkClassOfService) setServiceInstanceProfile(ServiceInstanceModifyProfile serviceInstanceProfile) setSupportOutdial(Boolean supportOutdial) setUnassignPhoneNumbers(UnassignPhoneNumbersLevel unassignPhoneNumbers) setUser(CollaborateBridge user) 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
-
maximumBridgeParticipants
-
networkClassOfService
-
maxCollaborateRoomParticipants
-
supportOutdial
-
collaborateOwnerUserIdList
-
serviceList
-
-
Constructor Details
-
GroupCollaborateBridgeConsolidatedModifyInstanceRequest
public GroupCollaborateBridgeConsolidatedModifyInstanceRequest() -
GroupCollaborateBridgeConsolidatedModifyInstanceRequest
-
-
Method Details
-
setUser
-
getCollaborateBridge
-
setUnassignPhoneNumbers
public CollaborateBridge.GroupCollaborateBridgeConsolidatedModifyInstanceRequest setUnassignPhoneNumbers(UnassignPhoneNumbersLevel unassignPhoneNumbers) -
getUnassignPhoneNumbers
-
setFlagAddPhoneNumberToGroup
public CollaborateBridge.GroupCollaborateBridgeConsolidatedModifyInstanceRequest setFlagAddPhoneNumberToGroup() -
addPhoneNumberToGroupFlagExist
public boolean addPhoneNumberToGroupFlagExist() -
getAddPhoneNumberToGroup
-
setServiceInstanceProfile
public CollaborateBridge.GroupCollaborateBridgeConsolidatedModifyInstanceRequest setServiceInstanceProfile(ServiceInstanceModifyProfile serviceInstanceProfile) -
getServiceInstanceProfile
-
setMaximumBridgeParticipants
public CollaborateBridge.GroupCollaborateBridgeConsolidatedModifyInstanceRequest setMaximumBridgeParticipants(CollaborateBridgeMaximumParticipants maximumBridgeParticipants) -
getMaximumBridgeParticipants
-
setNetworkClassOfService
public CollaborateBridge.GroupCollaborateBridgeConsolidatedModifyInstanceRequest setNetworkClassOfService(String networkClassOfService) -
getNetworkClassOfService
-
setMaxCollaborateRoomParticipants
public CollaborateBridge.GroupCollaborateBridgeConsolidatedModifyInstanceRequest setMaxCollaborateRoomParticipants(Integer maxCollaborateRoomParticipants) -
getMaxCollaborateRoomParticipants
-
setSupportOutdial
public CollaborateBridge.GroupCollaborateBridgeConsolidatedModifyInstanceRequest setSupportOutdial(Boolean supportOutdial) -
getSupportOutdial
-
unsetCollaborateOwnerUserIdList
public CollaborateBridge.GroupCollaborateBridgeConsolidatedModifyInstanceRequest unsetCollaborateOwnerUserIdList() -
setCollaborateOwnerUserIdList
public CollaborateBridge.GroupCollaborateBridgeConsolidatedModifyInstanceRequest setCollaborateOwnerUserIdList(ReplacementUserIdList collaborateOwnerUserIdList) -
getCollaborateOwnerUserIdList
-
unsetServiceList
-
setServiceList
public CollaborateBridge.GroupCollaborateBridgeConsolidatedModifyInstanceRequest setServiceList(ReplacementConsolidatedUserServiceAssignmentList serviceList) -
getServiceList
-
getEmptyObject
public static CollaborateBridge.GroupCollaborateBridgeConsolidatedModifyInstanceRequest 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:
formRequestin classRequest<DefaultResponse>
-