Package co.ecg.alpaca.toolkit.generated

Class Enterprise.EnterpriseDepartmentGetListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<Enterprise.EnterpriseDepartmentGetListResponse>

co.ecg.alpaca.toolkit.generated.Enterprise.EnterpriseDepartmentGetListRequest

Enclosing class:

Enterprise

public static class Enterprise.EnterpriseDepartmentGetListRequest
extends Request<Enterprise.EnterpriseDepartmentGetListResponse>

Request a list of departments in an enterprise. You may request only the list of departments defined at the enterprise-level, or you may request the list of all departments in the enterprise including all the departments defined within the groups inside the enterprise. The response is either EnterpriseDepartmentGetListResponse 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 @Valid Enterprise	enterprise
protected @NotNull Boolean	includeGroupDepartments

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

log

Constructor Summary

Constructors

Constructor	Description
EnterpriseDepartmentGetListRequest()
EnterpriseDepartmentGetListRequest(Enterprise enterprise, Boolean includeGroupDepartments)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static Enterprise.EnterpriseDepartmentGetListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Enterprise	getEnterprise()
Boolean	getIncludeGroupDepartments()
Enterprise.EnterpriseDepartmentGetListRequest	setEnterprise(Enterprise enterprise)
Enterprise.EnterpriseDepartmentGetListRequest	setIncludeGroupDepartments(Boolean includeGroupDepartments)

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

enterprise

@NotNull
@Valid
protected transient @NotNull @Valid Enterprise enterprise

includeGroupDepartments

@NotNull
protected @NotNull Boolean includeGroupDepartments

Constructor Details

EnterpriseDepartmentGetListRequest

public EnterpriseDepartmentGetListRequest()

EnterpriseDepartmentGetListRequest

public EnterpriseDepartmentGetListRequest(Enterprise enterprise,
 Boolean includeGroupDepartments)

Method Details

setEnterprise

public Enterprise.EnterpriseDepartmentGetListRequest setEnterprise(Enterprise enterprise)

getEnterprise

public Enterprise getEnterprise()

setIncludeGroupDepartments

public Enterprise.EnterpriseDepartmentGetListRequest setIncludeGroupDepartments(Boolean includeGroupDepartments)

getIncludeGroupDepartments

public Boolean getIncludeGroupDepartments()

getEmptyObject

public static Enterprise.EnterpriseDepartmentGetListRequest 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<Enterprise.EnterpriseDepartmentGetListResponse>