Package co.ecg.alpaca.toolkit.generated

Class CollaborateBridge.GroupCollaborateBridgeAddInstanceRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.CollaborateBridge.GroupCollaborateBridgeAddInstanceRequest

Enclosing class:

CollaborateBridge

public static class CollaborateBridge.GroupCollaborateBridgeAddInstanceRequest
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. 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 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 @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
GroupCollaborateBridgeAddInstanceRequest()
GroupCollaborateBridgeAddInstanceRequest(BroadWorksServer broadWorksServer, String serviceProviderId, String groupId, String serviceUserId, ServiceInstanceAddProfile serviceInstanceProfile, CollaborateBridgeMaximumParticipants maximumBridgeParticipants, Integer maxCollaborateRoomParticipants, Boolean supportOutdial)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String[]	getCollaborateOwnerUserId()
static CollaborateBridge.GroupCollaborateBridgeAddInstanceRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getGroupId()
Integer	getMaxCollaborateRoomParticipants()
CollaborateBridgeMaximumParticipants	getMaximumBridgeParticipants()
String	getNetworkClassOfService()
ServiceInstanceAddProfile	getServiceInstanceProfile()
String	getServiceProviderId()
String	getServiceUserId()
Boolean	getSupportOutdial()
CollaborateBridge.GroupCollaborateBridgeAddInstanceRequest	setCollaborateOwnerUserId(String... collaborateOwnerUserId)
CollaborateBridge.GroupCollaborateBridgeAddInstanceRequest	setGroupId(String groupId)
CollaborateBridge.GroupCollaborateBridgeAddInstanceRequest	setMaxCollaborateRoomParticipants(Integer maxCollaborateRoomParticipants)
CollaborateBridge.GroupCollaborateBridgeAddInstanceRequest	setMaximumBridgeParticipants(CollaborateBridgeMaximumParticipants maximumBridgeParticipants)
CollaborateBridge.GroupCollaborateBridgeAddInstanceRequest	setNetworkClassOfService(String networkClassOfService)
CollaborateBridge.GroupCollaborateBridgeAddInstanceRequest	setServiceInstanceProfile(ServiceInstanceAddProfile serviceInstanceProfile)
CollaborateBridge.GroupCollaborateBridgeAddInstanceRequest	setServiceProviderId(String serviceProviderId)
CollaborateBridge.GroupCollaborateBridgeAddInstanceRequest	setServiceUserId(String serviceUserId)
CollaborateBridge.GroupCollaborateBridgeAddInstanceRequest	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

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

Constructor Details

GroupCollaborateBridgeAddInstanceRequest

public GroupCollaborateBridgeAddInstanceRequest()

GroupCollaborateBridgeAddInstanceRequest

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

Method Details

setServiceProviderId

public CollaborateBridge.GroupCollaborateBridgeAddInstanceRequest setServiceProviderId(String serviceProviderId)

getServiceProviderId

public String getServiceProviderId()

setGroupId

public CollaborateBridge.GroupCollaborateBridgeAddInstanceRequest setGroupId(String groupId)

getGroupId

public String getGroupId()

setServiceUserId

public CollaborateBridge.GroupCollaborateBridgeAddInstanceRequest setServiceUserId(String serviceUserId)

getServiceUserId

public String getServiceUserId()

setServiceInstanceProfile

public CollaborateBridge.GroupCollaborateBridgeAddInstanceRequest setServiceInstanceProfile(ServiceInstanceAddProfile serviceInstanceProfile)

getServiceInstanceProfile

public ServiceInstanceAddProfile getServiceInstanceProfile()

setMaximumBridgeParticipants

public CollaborateBridge.GroupCollaborateBridgeAddInstanceRequest setMaximumBridgeParticipants(CollaborateBridgeMaximumParticipants maximumBridgeParticipants)

getMaximumBridgeParticipants

public CollaborateBridgeMaximumParticipants getMaximumBridgeParticipants()

setNetworkClassOfService

public CollaborateBridge.GroupCollaborateBridgeAddInstanceRequest setNetworkClassOfService(String networkClassOfService)

getNetworkClassOfService

public String getNetworkClassOfService()

setMaxCollaborateRoomParticipants

public CollaborateBridge.GroupCollaborateBridgeAddInstanceRequest setMaxCollaborateRoomParticipants(Integer maxCollaborateRoomParticipants)

getMaxCollaborateRoomParticipants

public Integer getMaxCollaborateRoomParticipants()

setSupportOutdial

public CollaborateBridge.GroupCollaborateBridgeAddInstanceRequest setSupportOutdial(Boolean supportOutdial)

getSupportOutdial

public Boolean getSupportOutdial()

setCollaborateOwnerUserId

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

getCollaborateOwnerUserId

public String[] getCollaborateOwnerUserId()

getEmptyObject

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