co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemAdminAddRequest

java.lang.Object

co.ecg.alpaca.toolkit.Request<Response.DefaultResponse>

co.ecg.alpaca.toolkit.generated.BWSystem.SystemAdminAddRequest

All Implemented Interfaces:

Runnable

Enclosing class:

BWSystem

public static class BWSystem.SystemAdminAddRequest
extends Request<Response.DefaultResponse>

Add a system or provisioning administrator. The response is either a SuccessResponse or an ErrorResponse.

Field Summary

Fields

Modifier and Type	Field and Description
SystemAdminType	adminType
boolean	adminTypeIsModified
String	firstName
boolean	firstNameIsModified
String	language
boolean	languageIsModified
String	lastName
boolean	lastNameIsModified
String	password
boolean	passwordIsModified
Boolean	readOnly
boolean	readOnlyIsModified
User	user
boolean	userIsModified

Constructor Summary

Constructors

Constructor and Description
SystemAdminAddRequest(BroadWorksServer bws) Default Constructor -- Not Guaranteed to work without checking Request validity with isValid()
SystemAdminAddRequest(User user, String password, SystemAdminType adminType, Boolean readOnly)

Method Summary

Modifier and Type	Method and Description
void	formRequest() Forms the XML Document for this Request Object.
SystemAdminType	getAdminType()
String	getFirstName()
String	getLanguage()
String	getLastName()
String	getPassword()
Boolean	getReadOnly()
User	getUser()
BWSystem.SystemAdminAddRequest	setAdminType(SystemAdminType adminType)
BWSystem.SystemAdminAddRequest	setFirstName(String firstName)
BWSystem.SystemAdminAddRequest	setLanguage(String language)
BWSystem.SystemAdminAddRequest	setLastName(String lastName)
BWSystem.SystemAdminAddRequest	setPassword(String password)
BWSystem.SystemAdminAddRequest	setReadOnly(Boolean readOnly)
BWSystem.SystemAdminAddRequest	setUser(User user)

Methods inherited from class co.ecg.alpaca.toolkit.Request

appendChild, appendChild, appendChild, asyncFire, createElement, createNilElement, createTextElement, fire, fire, getBroadWorksServer, getCommandType, getDomDocument, getResponseClass, isMemberOfBundle, isValid, run, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setMemberOfBundle, setRequestId, setResponseClass, setRootElement, toString, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

user

@NotNull
public User user

userIsModified

public transient boolean userIsModified

firstName

@Size(min=1,
      max=30)
public String firstName

firstNameIsModified

public transient boolean firstNameIsModified

lastName

@Size(min=1,
      max=30)
public String lastName

lastNameIsModified

public transient boolean lastNameIsModified

password

@Size(min=1,
      max=60)
public String password

passwordIsModified

public transient boolean passwordIsModified

language

@Size(min=1,
      max=40)
public String language

languageIsModified

public transient boolean languageIsModified

adminType

public SystemAdminType adminType

adminTypeIsModified

public transient boolean adminTypeIsModified

readOnly

public Boolean readOnly

readOnlyIsModified

public transient boolean readOnlyIsModified

Constructor Detail

SystemAdminAddRequest

public SystemAdminAddRequest(User user,
                             String password,
                             SystemAdminType adminType,
                             Boolean readOnly)

SystemAdminAddRequest

public SystemAdminAddRequest(BroadWorksServer bws)

Default Constructor -- Not Guaranteed to work without checking Request validity with isValid()

Parameters:

bws - The BroadWorksServer to use for the Request

Method Detail

setUser

public BWSystem.SystemAdminAddRequest setUser(User user)

getUser

public User getUser()

setFirstName

public BWSystem.SystemAdminAddRequest setFirstName(String firstName)

getFirstName

public String getFirstName()

setLastName

public BWSystem.SystemAdminAddRequest setLastName(String lastName)

getLastName

public String getLastName()

setPassword

public BWSystem.SystemAdminAddRequest setPassword(String password)

getPassword

public String getPassword()

setLanguage

public BWSystem.SystemAdminAddRequest setLanguage(String language)

getLanguage

public String getLanguage()

setAdminType

public BWSystem.SystemAdminAddRequest setAdminType(SystemAdminType adminType)

getAdminType

public SystemAdminType getAdminType()

setReadOnly

public BWSystem.SystemAdminAddRequest setReadOnly(Boolean readOnly)

getReadOnly

public Boolean getReadOnly()

formRequest

public void formRequest()
                 throws RequestException

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

Specified by:

formRequest in class Request<Response.DefaultResponse>

Throws:

RequestException