Package co.ecg.alpaca.toolkit.generated.services

Class UserCommPilotExpress.UserCommPilotExpressModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.services.UserCommPilotExpress.UserCommPilotExpressModifyRequest

Enclosing class:

UserCommPilotExpress

public static class UserCommPilotExpress.UserCommPilotExpressModifyRequest
extends Request<DefaultResponse>

Modify the user's commPilot express service setting. The response is either a SuccessResponse or an ErrorResponse. Engineering Note: This command is used internally by Call Processing.

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 @Valid CommPilotExpressAvailableInOfficeModify	availableInOffice
protected @Valid CommPilotExpressAvailableOutOfOfficeModify	availableOutOfOffice
protected @Valid CommPilotExpressBusyModify	busy
protected Optional<CommPilotExpressProfile>	profile
protected @Valid CommPilotExpressUnavailableModify	unavailable
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserCommPilotExpressModifyRequest()
UserCommPilotExpressModifyRequest(BroadWorksUser user)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
CommPilotExpressAvailableInOfficeModify	getAvailableInOffice()
CommPilotExpressAvailableOutOfOfficeModify	getAvailableOutOfOffice()
BroadWorksUser	getBroadWorksUser()
CommPilotExpressBusyModify	getBusy()
static UserCommPilotExpress.UserCommPilotExpressModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Optional<CommPilotExpressProfile>	getProfile()
CommPilotExpressUnavailableModify	getUnavailable()
UserCommPilotExpress.UserCommPilotExpressModifyRequest	setAvailableInOffice(CommPilotExpressAvailableInOfficeModify availableInOffice)
UserCommPilotExpress.UserCommPilotExpressModifyRequest	setAvailableOutOfOffice(CommPilotExpressAvailableOutOfOfficeModify availableOutOfOffice)
UserCommPilotExpress.UserCommPilotExpressModifyRequest	setBusy(CommPilotExpressBusyModify busy)
UserCommPilotExpress.UserCommPilotExpressModifyRequest	setProfile(CommPilotExpressProfile profile)
UserCommPilotExpress.UserCommPilotExpressModifyRequest	setUnavailable(CommPilotExpressUnavailableModify unavailable)
UserCommPilotExpress.UserCommPilotExpressModifyRequest	setUser(BroadWorksUser user)
UserCommPilotExpress.UserCommPilotExpressModifyRequest	unsetProfile()

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

profile

protected Optional<CommPilotExpressProfile> profile

availableInOffice

@Valid
protected @Valid CommPilotExpressAvailableInOfficeModify availableInOffice

availableOutOfOffice

@Valid
protected @Valid CommPilotExpressAvailableOutOfOfficeModify availableOutOfOffice

busy

@Valid
protected @Valid CommPilotExpressBusyModify busy

unavailable

@Valid
protected @Valid CommPilotExpressUnavailableModify unavailable

Constructor Details

UserCommPilotExpressModifyRequest

public UserCommPilotExpressModifyRequest()

UserCommPilotExpressModifyRequest

public UserCommPilotExpressModifyRequest(BroadWorksUser user)

Method Details

setUser

public UserCommPilotExpress.UserCommPilotExpressModifyRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

unsetProfile

public UserCommPilotExpress.UserCommPilotExpressModifyRequest unsetProfile()

setProfile

public UserCommPilotExpress.UserCommPilotExpressModifyRequest setProfile(CommPilotExpressProfile profile)

getProfile

public Optional<CommPilotExpressProfile> getProfile()

setAvailableInOffice

public UserCommPilotExpress.UserCommPilotExpressModifyRequest setAvailableInOffice(CommPilotExpressAvailableInOfficeModify availableInOffice)

getAvailableInOffice

public CommPilotExpressAvailableInOfficeModify getAvailableInOffice()

setAvailableOutOfOffice

public UserCommPilotExpress.UserCommPilotExpressModifyRequest setAvailableOutOfOffice(CommPilotExpressAvailableOutOfOfficeModify availableOutOfOffice)

getAvailableOutOfOffice

public CommPilotExpressAvailableOutOfOfficeModify getAvailableOutOfOffice()

setBusy

public UserCommPilotExpress.UserCommPilotExpressModifyRequest setBusy(CommPilotExpressBusyModify busy)

getBusy

public CommPilotExpressBusyModify getBusy()

setUnavailable

public UserCommPilotExpress.UserCommPilotExpressModifyRequest setUnavailable(CommPilotExpressUnavailableModify unavailable)

getUnavailable

public CommPilotExpressUnavailableModify getUnavailable()

getEmptyObject

public static UserCommPilotExpress.UserCommPilotExpressModifyRequest 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>