Package co.ecg.alpaca.toolkit.generated

Class User.UserAnnouncementFileDeleteListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.User.UserAnnouncementFileDeleteListRequest

Enclosing class:

User

@ChoiceGroup("announcementFileKey") @ChoiceGroup("announcementFileExternalId")
public static class User.UserAnnouncementFileDeleteListRequest
extends Request<DefaultResponse>

Delete one or more announcements from the user announcement repository The following elements are only used in AS data mode and ignored in XS data mode: announcementFileExternalId 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 String[]	announcementFileExternalId
protected @Valid AnnouncementFileKey[]	announcementFileKey
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserAnnouncementFileDeleteListRequest()
UserAnnouncementFileDeleteListRequest(BroadWorksUser user)
UserAnnouncementFileDeleteListRequest(BroadWorksUser user, AnnouncementFileKey... announcementFileKey)
UserAnnouncementFileDeleteListRequest(BroadWorksUser user, String... announcementFileExternalId)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String[]	getAnnouncementFileExternalId()
AnnouncementFileKey[]	getAnnouncementFileKey()
BroadWorksUser	getBroadWorksUser()
static User.UserAnnouncementFileDeleteListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
User.UserAnnouncementFileDeleteListRequest	setAnnouncementFileExternalId(String... announcementFileExternalId)
User.UserAnnouncementFileDeleteListRequest	setAnnouncementFileKey(AnnouncementFileKey... announcementFileKey)
User.UserAnnouncementFileDeleteListRequest	setUser(BroadWorksUser 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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

user

@NotNull
@Valid
protected transient @NotNull @Valid BroadWorksUser user

announcementFileKey

@Valid
protected @Valid AnnouncementFileKey[] announcementFileKey

announcementFileExternalId

@StringArrayElementSize(max=36)
protected String[] announcementFileExternalId

Constructor Details

UserAnnouncementFileDeleteListRequest

public UserAnnouncementFileDeleteListRequest()

UserAnnouncementFileDeleteListRequest

public UserAnnouncementFileDeleteListRequest(BroadWorksUser user)

UserAnnouncementFileDeleteListRequest

public UserAnnouncementFileDeleteListRequest(BroadWorksUser user,
 AnnouncementFileKey... announcementFileKey)

UserAnnouncementFileDeleteListRequest

public UserAnnouncementFileDeleteListRequest(BroadWorksUser user,
 String... announcementFileExternalId)

Method Details

setUser

public User.UserAnnouncementFileDeleteListRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setAnnouncementFileKey

public User.UserAnnouncementFileDeleteListRequest setAnnouncementFileKey(AnnouncementFileKey... announcementFileKey)

getAnnouncementFileKey

public AnnouncementFileKey[] getAnnouncementFileKey()

setAnnouncementFileExternalId

public User.UserAnnouncementFileDeleteListRequest setAnnouncementFileExternalId(String... announcementFileExternalId)

getAnnouncementFileExternalId

public String[] getAnnouncementFileExternalId()

getEmptyObject

public static User.UserAnnouncementFileDeleteListRequest 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>