co.ecg.alpaca.toolkit.generated

Class Enterprise.EnterpriseDepartmentGetListRequest

java.lang.Object

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

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

All Implemented Interfaces:

Runnable

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.

Field Summary

Fields

Modifier and Type	Field and Description
Enterprise	enterprise
boolean	enterpriseIsModified
Boolean	includeGroupDepartments
boolean	includeGroupDepartmentsIsModified

Constructor Summary

Constructors

Constructor and Description
EnterpriseDepartmentGetListRequest(BroadWorksServer bws) Default Constructor -- Not Guaranteed to work without checking Request validity with isValid()
EnterpriseDepartmentGetListRequest(Enterprise enterprise, Boolean includeGroupDepartments)

Method Summary

Modifier and Type	Method and Description
void	formRequest() Forms the XML Document for this Request Object.
Enterprise	getEnterprise()
Boolean	getIncludeGroupDepartments()
Enterprise.EnterpriseDepartmentGetListRequest	setEnterprise(Enterprise enterprise)
Enterprise.EnterpriseDepartmentGetListRequest	setIncludeGroupDepartments(Boolean includeGroupDepartments)

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

enterprise

@NotNull
public Enterprise enterprise

enterpriseIsModified

public transient boolean enterpriseIsModified

includeGroupDepartments

public Boolean includeGroupDepartments

includeGroupDepartmentsIsModified

public transient boolean includeGroupDepartmentsIsModified

Constructor Detail

EnterpriseDepartmentGetListRequest

public EnterpriseDepartmentGetListRequest(Enterprise enterprise,
                                          Boolean includeGroupDepartments)

EnterpriseDepartmentGetListRequest

public EnterpriseDepartmentGetListRequest(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

setEnterprise

public Enterprise.EnterpriseDepartmentGetListRequest setEnterprise(Enterprise enterprise)

getEnterprise

public Enterprise getEnterprise()

setIncludeGroupDepartments

public Enterprise.EnterpriseDepartmentGetListRequest setIncludeGroupDepartments(Boolean includeGroupDepartments)

getIncludeGroupDepartments

public Boolean getIncludeGroupDepartments()

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<Enterprise.EnterpriseDepartmentGetListResponse>

Throws:

RequestException