Package co.ecg.alpaca.toolkit.generated

Class Login.UserGetLoginInfoRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<Login.UserGetLoginInfoResponse>

co.ecg.alpaca.toolkit.generated.Login.UserGetLoginInfoRequest

Enclosing class:

Login

@ChoiceGroup("phoneNumber") @ChoiceGroup("linePort") @ChoiceGroup({"userId","loginRole"})
public static class Login.UserGetLoginInfoRequest
extends Request<Login.UserGetLoginInfoResponse>

UserGetLoginInfoRequest22V4 is used to access login information for a user either by a userId, dn or lineport. The phone number may be any DN associated with a user. The lineport may be any lineport associated with a user. The response is a UserGetLoginInfoResponse22V4 or an ErrorResponse. The following elements are only used in AS data mode and ignored in XS and Amplify data mode. loginRole

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 @Size(min=1,max=161) String	linePort
protected LoginRole	loginRole
protected @Size(min=1,max=23) String	phoneNumber
protected @Size(min=1,max=161) String	userId

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

log

Constructor Summary

Constructors

Constructor	Description
UserGetLoginInfoRequest()
UserGetLoginInfoRequest(BroadWorksServer broadWorksServer)
UserGetLoginInfoRequest(BroadWorksServer broadWorksServer, String phoneNumber)
UserGetLoginInfoRequest(BroadWorksServer broadWorksServer, String userId, LoginRole loginRole)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String	getLinePort()
LoginRole	getLoginRole()
String	getPhoneNumber()
String	getUserId()
Login.UserGetLoginInfoRequest	setLinePort(String linePort)
Login.UserGetLoginInfoRequest	setLoginRole(LoginRole loginRole)
Login.UserGetLoginInfoRequest	setPhoneNumber(String phoneNumber)
Login.UserGetLoginInfoRequest	setUserId(String userId)

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

userId

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

loginRole

protected LoginRole loginRole

phoneNumber

@Size(min=1,
      max=23)
protected @Size(min=1,max=23) String phoneNumber

linePort

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

Constructor Details

UserGetLoginInfoRequest

public UserGetLoginInfoRequest()

UserGetLoginInfoRequest

public UserGetLoginInfoRequest(BroadWorksServer broadWorksServer)

UserGetLoginInfoRequest

public UserGetLoginInfoRequest(BroadWorksServer broadWorksServer,
 String userId,
 LoginRole loginRole)

UserGetLoginInfoRequest

public UserGetLoginInfoRequest(BroadWorksServer broadWorksServer,
 String phoneNumber)

Method Details

setUserId

public Login.UserGetLoginInfoRequest setUserId(String userId)

getUserId

public String getUserId()

setLoginRole

public Login.UserGetLoginInfoRequest setLoginRole(LoginRole loginRole)

getLoginRole

public LoginRole getLoginRole()

setPhoneNumber

public Login.UserGetLoginInfoRequest setPhoneNumber(String phoneNumber)

getPhoneNumber

public String getPhoneNumber()

setLinePort

public Login.UserGetLoginInfoRequest setLinePort(String linePort)

getLinePort

public String getLinePort()

formRequest

public void formRequest()

Forms the XML Document for this Request Object. Called by the Request upon fire().

Overrides:

formRequest in class Request<Login.UserGetLoginInfoResponse>