Package co.ecg.alpaca.toolkit.generated

Class CollaborateBridge.GroupCollaborateBridgeConsolidatedDeleteInstanceRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.CollaborateBridge.GroupCollaborateBridgeConsolidatedDeleteInstanceRequest

Enclosing class:

CollaborateBridge

public static class CollaborateBridge.GroupCollaborateBridgeConsolidatedDeleteInstanceRequest
extends Request<DefaultResponse>

Delete a collaborate bridge from a group. The request fails when attempting to delete the default collaborate bridge. 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. 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 UnassignPhoneNumbersLevel	unassignPhoneNumbers
protected @NotNull @Valid CollaborateBridge	user

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

log

Constructor Summary

Constructors

Constructor	Description
GroupCollaborateBridgeConsolidatedDeleteInstanceRequest()
GroupCollaborateBridgeConsolidatedDeleteInstanceRequest(CollaborateBridge user)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
CollaborateBridge	getCollaborateBridge()
static CollaborateBridge.GroupCollaborateBridgeConsolidatedDeleteInstanceRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
UnassignPhoneNumbersLevel	getUnassignPhoneNumbers()
CollaborateBridge.GroupCollaborateBridgeConsolidatedDeleteInstanceRequest	setUnassignPhoneNumbers(UnassignPhoneNumbersLevel unassignPhoneNumbers)
CollaborateBridge.GroupCollaborateBridgeConsolidatedDeleteInstanceRequest	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, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setEcho, 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

user

@NotNull @Valid protected transient @NotNull @Valid CollaborateBridge user

unassignPhoneNumbers

protected UnassignPhoneNumbersLevel unassignPhoneNumbers

Constructor Details

GroupCollaborateBridgeConsolidatedDeleteInstanceRequest

public GroupCollaborateBridgeConsolidatedDeleteInstanceRequest()

GroupCollaborateBridgeConsolidatedDeleteInstanceRequest

public GroupCollaborateBridgeConsolidatedDeleteInstanceRequest(CollaborateBridge user)

Method Details

setUser

public CollaborateBridge.GroupCollaborateBridgeConsolidatedDeleteInstanceRequest setUser(CollaborateBridge user)

getCollaborateBridge

public CollaborateBridge getCollaborateBridge()

setUnassignPhoneNumbers

public CollaborateBridge.GroupCollaborateBridgeConsolidatedDeleteInstanceRequest setUnassignPhoneNumbers(UnassignPhoneNumbersLevel unassignPhoneNumbers)

getUnassignPhoneNumbers

public UnassignPhoneNumbersLevel getUnassignPhoneNumbers()

getEmptyObject

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