Package co.ecg.alpaca.toolkit.generated

Class ServiceProvider.ServiceProviderScheduleGetEventRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<ServiceProvider.ServiceProviderScheduleGetEventResponse>

co.ecg.alpaca.toolkit.generated.ServiceProvider.ServiceProviderScheduleGetEventRequest

Enclosing class:

ServiceProvider

public static class ServiceProvider.ServiceProviderScheduleGetEventRequest
extends Request<ServiceProvider.ServiceProviderScheduleGetEventResponse>

Get an event from a service provider schedule. The response is either a ServiceProviderScheduleGetEventResponse 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,max=40) String	eventName
protected @NotNull @Valid ScheduleKey	scheduleKey
protected @NotNull @Valid ServiceProvider	serviceProvider

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

log

Constructor Summary

Constructors

Constructor	Description
ServiceProviderScheduleGetEventRequest()
ServiceProviderScheduleGetEventRequest(ServiceProvider serviceProvider, ScheduleKey scheduleKey, String eventName)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static ServiceProvider.ServiceProviderScheduleGetEventRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getEventName()
ScheduleKey	getScheduleKey()
ServiceProvider	getServiceProvider()
ServiceProvider.ServiceProviderScheduleGetEventRequest	setEventName(String eventName)
ServiceProvider.ServiceProviderScheduleGetEventRequest	setScheduleKey(ScheduleKey scheduleKey)
ServiceProvider.ServiceProviderScheduleGetEventRequest	setServiceProvider(ServiceProvider serviceProvider)

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

serviceProvider

@NotNull
@Valid
protected transient @NotNull @Valid ServiceProvider serviceProvider

scheduleKey

@NotNull
@Valid
protected @NotNull @Valid ScheduleKey scheduleKey

eventName

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

Constructor Details

ServiceProviderScheduleGetEventRequest

public ServiceProviderScheduleGetEventRequest()

ServiceProviderScheduleGetEventRequest

public ServiceProviderScheduleGetEventRequest(ServiceProvider serviceProvider,
 ScheduleKey scheduleKey,
 String eventName)

Method Details

setServiceProvider

public ServiceProvider.ServiceProviderScheduleGetEventRequest setServiceProvider(ServiceProvider serviceProvider)

getServiceProvider

public ServiceProvider getServiceProvider()

setScheduleKey

public ServiceProvider.ServiceProviderScheduleGetEventRequest setScheduleKey(ScheduleKey scheduleKey)

getScheduleKey

public ScheduleKey getScheduleKey()

setEventName

public ServiceProvider.ServiceProviderScheduleGetEventRequest setEventName(String eventName)

getEventName

public String getEventName()

getEmptyObject

public static ServiceProvider.ServiceProviderScheduleGetEventRequest 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<ServiceProvider.ServiceProviderScheduleGetEventResponse>