Package co.ecg.alpaca.toolkit.generated

Class CollaborateBridge.GroupCollaborateBridgeConsolidatedAddInstanceRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.CollaborateBridge.GroupCollaborateBridgeConsolidatedAddInstanceRequest

Enclosing class:

CollaborateBridge

public static class CollaborateBridge.GroupCollaborateBridgeConsolidatedAddInstanceRequest
extends Request<DefaultResponse>

Add a collaborate bridge to a group. The domain is required in the serviceUserId. The request fails when supportOutdial is enabled and the system-level collaborate supportOutdial setting is disabled. 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.

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 @AssertTrue Boolean	addPhoneNumberToGroup
protected String[]	collaborateOwnerUserId
protected @NotNull @Size(min=1,max=30) String	groupId
protected @NotNull Integer	maxCollaborateRoomParticipants
protected @NotNull @Valid CollaborateBridgeMaximumParticipants	maximumBridgeParticipants
protected @Size(min=1,max=40) String	networkClassOfService
protected @Valid ConsolidatedUserServiceAssignment[]	service
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	supportOutdial

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

log

Constructor Summary

Constructors

Constructor	Description
GroupCollaborateBridgeConsolidatedAddInstanceRequest()
GroupCollaborateBridgeConsolidatedAddInstanceRequest(BroadWorksServer broadWorksServer, String serviceProviderId, String groupId, String serviceUserId, ServiceInstanceAddProfile serviceInstanceProfile, CollaborateBridgeMaximumParticipants maximumBridgeParticipants, Integer maxCollaborateRoomParticipants, Boolean supportOutdial)

Method Summary

Modifier and Type	Method	Description
boolean	addPhoneNumberToGroupFlagExist()
void	formRequest()	Forms the XML Document for this Request Object.
Boolean	getAddPhoneNumberToGroup()
String[]	getCollaborateOwnerUserId()
static CollaborateBridge.GroupCollaborateBridgeConsolidatedAddInstanceRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getGroupId()
Integer	getMaxCollaborateRoomParticipants()
CollaborateBridgeMaximumParticipants	getMaximumBridgeParticipants()
String	getNetworkClassOfService()
ConsolidatedUserServiceAssignment[]	getService()
ServiceInstanceAddProfile	getServiceInstanceProfile()
String	getServiceProviderId()
String	getServiceUserId()
Boolean	getSupportOutdial()
CollaborateBridge.GroupCollaborateBridgeConsolidatedAddInstanceRequest	setCollaborateOwnerUserId(String... collaborateOwnerUserId)
CollaborateBridge.GroupCollaborateBridgeConsolidatedAddInstanceRequest	setFlagAddPhoneNumberToGroup()
CollaborateBridge.GroupCollaborateBridgeConsolidatedAddInstanceRequest	setGroupId(String groupId)
CollaborateBridge.GroupCollaborateBridgeConsolidatedAddInstanceRequest	setMaxCollaborateRoomParticipants(Integer maxCollaborateRoomParticipants)
CollaborateBridge.GroupCollaborateBridgeConsolidatedAddInstanceRequest	setMaximumBridgeParticipants(CollaborateBridgeMaximumParticipants maximumBridgeParticipants)
CollaborateBridge.GroupCollaborateBridgeConsolidatedAddInstanceRequest	setNetworkClassOfService(String networkClassOfService)
CollaborateBridge.GroupCollaborateBridgeConsolidatedAddInstanceRequest	setService(ConsolidatedUserServiceAssignment... service)
CollaborateBridge.GroupCollaborateBridgeConsolidatedAddInstanceRequest	setServiceInstanceProfile(ServiceInstanceAddProfile serviceInstanceProfile)
CollaborateBridge.GroupCollaborateBridgeConsolidatedAddInstanceRequest	setServiceProviderId(String serviceProviderId)
CollaborateBridge.GroupCollaborateBridgeConsolidatedAddInstanceRequest	setServiceUserId(String serviceUserId)
CollaborateBridge.GroupCollaborateBridgeConsolidatedAddInstanceRequest	setSupportOutdial(Boolean supportOutdial)

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 Details

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

maximumBridgeParticipants

@NotNull
@Valid
protected @NotNull @Valid CollaborateBridgeMaximumParticipants maximumBridgeParticipants

networkClassOfService

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

maxCollaborateRoomParticipants

@NotNull
protected @NotNull Integer maxCollaborateRoomParticipants

supportOutdial

@NotNull
protected @NotNull Boolean supportOutdial

collaborateOwnerUserId

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

service

@Valid
protected @Valid ConsolidatedUserServiceAssignment[] service

Constructor Details

GroupCollaborateBridgeConsolidatedAddInstanceRequest

public GroupCollaborateBridgeConsolidatedAddInstanceRequest()

GroupCollaborateBridgeConsolidatedAddInstanceRequest

public GroupCollaborateBridgeConsolidatedAddInstanceRequest(BroadWorksServer broadWorksServer,
 String serviceProviderId,
 String groupId,
 String serviceUserId,
 ServiceInstanceAddProfile serviceInstanceProfile,
 CollaborateBridgeMaximumParticipants maximumBridgeParticipants,
 Integer maxCollaborateRoomParticipants,
 Boolean supportOutdial)

Method Details

setServiceProviderId

public CollaborateBridge.GroupCollaborateBridgeConsolidatedAddInstanceRequest setServiceProviderId(String serviceProviderId)

getServiceProviderId

public String getServiceProviderId()

setGroupId

public CollaborateBridge.GroupCollaborateBridgeConsolidatedAddInstanceRequest setGroupId(String groupId)

getGroupId

public String getGroupId()

setServiceUserId

public CollaborateBridge.GroupCollaborateBridgeConsolidatedAddInstanceRequest setServiceUserId(String serviceUserId)

getServiceUserId

public String getServiceUserId()

setFlagAddPhoneNumberToGroup

public CollaborateBridge.GroupCollaborateBridgeConsolidatedAddInstanceRequest setFlagAddPhoneNumberToGroup()

addPhoneNumberToGroupFlagExist

public boolean addPhoneNumberToGroupFlagExist()

getAddPhoneNumberToGroup

public Boolean getAddPhoneNumberToGroup()

setServiceInstanceProfile

public CollaborateBridge.GroupCollaborateBridgeConsolidatedAddInstanceRequest setServiceInstanceProfile(ServiceInstanceAddProfile serviceInstanceProfile)

getServiceInstanceProfile

public ServiceInstanceAddProfile getServiceInstanceProfile()

setMaximumBridgeParticipants

public CollaborateBridge.GroupCollaborateBridgeConsolidatedAddInstanceRequest setMaximumBridgeParticipants(CollaborateBridgeMaximumParticipants maximumBridgeParticipants)

getMaximumBridgeParticipants

public CollaborateBridgeMaximumParticipants getMaximumBridgeParticipants()

setNetworkClassOfService

public CollaborateBridge.GroupCollaborateBridgeConsolidatedAddInstanceRequest setNetworkClassOfService(String networkClassOfService)

getNetworkClassOfService

public String getNetworkClassOfService()

setMaxCollaborateRoomParticipants

public CollaborateBridge.GroupCollaborateBridgeConsolidatedAddInstanceRequest setMaxCollaborateRoomParticipants(Integer maxCollaborateRoomParticipants)

getMaxCollaborateRoomParticipants

public Integer getMaxCollaborateRoomParticipants()

setSupportOutdial

public CollaborateBridge.GroupCollaborateBridgeConsolidatedAddInstanceRequest setSupportOutdial(Boolean supportOutdial)

getSupportOutdial

public Boolean getSupportOutdial()

setCollaborateOwnerUserId

public CollaborateBridge.GroupCollaborateBridgeConsolidatedAddInstanceRequest setCollaborateOwnerUserId(String... collaborateOwnerUserId)

getCollaborateOwnerUserId

public String[] getCollaborateOwnerUserId()

setService

public CollaborateBridge.GroupCollaborateBridgeConsolidatedAddInstanceRequest setService(ConsolidatedUserServiceAssignment... service)

getService

public ConsolidatedUserServiceAssignment[] getService()

getEmptyObject

public static CollaborateBridge.GroupCollaborateBridgeConsolidatedAddInstanceRequest 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>