Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemExportBroadCloudDataRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemExportBroadCloudDataRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemExportBroadCloudDataRequest
extends Request<DefaultResponse>

Request to export all users that have BroadCloud services, such as user profile information and BroadCloud services related information for that user to a file so they can be uploaded to a Messaging Server/BroadCloud. The response is either a SuccessResponse or an 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 @NotNull @Size(min=1) String	fileName

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

log

Constructor Summary

Constructors

Constructor	Description
SystemExportBroadCloudDataRequest()
SystemExportBroadCloudDataRequest(BroadWorksServer broadWorksServer, String fileName)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static BWSystem.SystemExportBroadCloudDataRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getFileName()
BWSystem.SystemExportBroadCloudDataRequest	setFileName(String fileName)

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

fileName

@NotNull
@Size(min=1)
protected @NotNull @Size(min=1) String fileName

Constructor Details

SystemExportBroadCloudDataRequest

public SystemExportBroadCloudDataRequest()

SystemExportBroadCloudDataRequest

public SystemExportBroadCloudDataRequest(BroadWorksServer broadWorksServer,
 String fileName)

Method Details

setFileName

public BWSystem.SystemExportBroadCloudDataRequest setFileName(String fileName)

getFileName

public String getFileName()

getEmptyObject

public static BWSystem.SystemExportBroadCloudDataRequest 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>