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

Class ReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseNoteModifyListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.services.ReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseNoteModifyListRequest

Enclosing class:

ReceptionistEnterprise

public static class ReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseNoteModifyListRequest
extends Request<DefaultResponse>

Add a list of notes for an existing Receptionist user. The response is either a SuccessResponse or an ErrorResponse. If some of the users add and some users fail to add, then the response will contain a WarningResponse containing only the a comma delimited list of users that failed to add. If the user sending the request is the not the owner of the Receptionist Note, then an ErrorResponse will be returned.

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 @Valid @Size(min=1,max=1000) ReceptionistContactUserAndNote[]	receptionistUserAndNote
protected @NotNull @Size(min=1,max=161) String	receptionistUserId

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

log

Constructor Summary

Constructors

Constructor	Description
UserBroadWorksReceptionistEnterpriseNoteModifyListRequest()
UserBroadWorksReceptionistEnterpriseNoteModifyListRequest(BroadWorksServer broadWorksServer, String receptionistUserId, ReceptionistContactUserAndNote... receptionistUserAndNote)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static ReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseNoteModifyListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
ReceptionistContactUserAndNote[]	getReceptionistUserAndNote()
String	getReceptionistUserId()
ReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseNoteModifyListRequest	setReceptionistUserAndNote(ReceptionistContactUserAndNote... receptionistUserAndNote)
ReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseNoteModifyListRequest	setReceptionistUserId(String receptionistUserId)

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

receptionistUserId

@NotNull
@Size(min=1,
      max=161)
protected @NotNull @Size(min=1,max=161) String receptionistUserId

receptionistUserAndNote

@NotNull
@Valid
@Size(min=1,
      max=1000)
protected @NotNull @Valid @Size(min=1,max=1000) ReceptionistContactUserAndNote[] receptionistUserAndNote

Constructor Details

UserBroadWorksReceptionistEnterpriseNoteModifyListRequest

public UserBroadWorksReceptionistEnterpriseNoteModifyListRequest()

UserBroadWorksReceptionistEnterpriseNoteModifyListRequest

public UserBroadWorksReceptionistEnterpriseNoteModifyListRequest(BroadWorksServer broadWorksServer,
 String receptionistUserId,
 ReceptionistContactUserAndNote... receptionistUserAndNote)

Method Details

setReceptionistUserId

public ReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseNoteModifyListRequest setReceptionistUserId(String receptionistUserId)

getReceptionistUserId

public String getReceptionistUserId()

setReceptionistUserAndNote

public ReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseNoteModifyListRequest setReceptionistUserAndNote(ReceptionistContactUserAndNote... receptionistUserAndNote)

getReceptionistUserAndNote

public ReceptionistContactUserAndNote[] getReceptionistUserAndNote()

getEmptyObject

public static ReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseNoteModifyListRequest 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>