Package co.ecg.alpaca.toolkit.generated

Class CallCenter.UserCallCenterAgentSignOutRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<CallCenter.UserCallCenterAgentSignOutResponse>

co.ecg.alpaca.toolkit.generated.CallCenter.UserCallCenterAgentSignOutRequest

Enclosing class:

CallCenter

public static class CallCenter.UserCallCenterAgentSignOutRequest
extends Request<CallCenter.UserCallCenterAgentSignOutResponse>

This request signs-out a call center agent. Administrator, supervisor and agent itself can sign-out an agent. An empty OCI table in OCI-P response indicates success and the agent has been signed out. This sign-out command will fail if the agent is the last signed-in agent of any standard or premium call center to which she is currently joined. If the sign-out fails, the OCI-P response will contain a list of Call Centers for which the agent is the last signed-in agent. If this special logic is not needed, UserCallCenterModifyRequest19 can still be used to change the agents ACD state without checking if the agent is the last signed-in agent. The response is either a UserCallCenterAgentSignOutResponse or 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=161) String	agentUserId

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

log

Constructor Summary

Constructors

Constructor	Description
UserCallCenterAgentSignOutRequest()
UserCallCenterAgentSignOutRequest(BroadWorksServer broadWorksServer, String agentUserId)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String	getAgentUserId()
static CallCenter.UserCallCenterAgentSignOutRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
CallCenter.UserCallCenterAgentSignOutRequest	setAgentUserId(String agentUserId)

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

agentUserId

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

Constructor Details

UserCallCenterAgentSignOutRequest

public UserCallCenterAgentSignOutRequest()

UserCallCenterAgentSignOutRequest

public UserCallCenterAgentSignOutRequest(BroadWorksServer broadWorksServer,
 String agentUserId)

Method Details

setAgentUserId

public CallCenter.UserCallCenterAgentSignOutRequest setAgentUserId(String agentUserId)

getAgentUserId

public String getAgentUserId()

getEmptyObject

public static CallCenter.UserCallCenterAgentSignOutRequest 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<CallCenter.UserCallCenterAgentSignOutResponse>