Package co.ecg.alpaca.toolkit.generated

Class RoutePoint.GroupRoutePointGetInstanceListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<RoutePoint.GroupRoutePointGetInstanceListResponse>

co.ecg.alpaca.toolkit.generated.RoutePoint.GroupRoutePointGetInstanceListRequest

Enclosing class:

RoutePoint

public static class RoutePoint.GroupRoutePointGetInstanceListRequest
extends Request<RoutePoint.GroupRoutePointGetInstanceListResponse>

Get a list of Route Point instances within a group. It is possible to search by various criteria to restrict the number of rows returned. The response is either GroupRoutePointGetInstanceListResponse or ErrorResponse. It is possible to get the instances within a specified department.

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 Group	group
protected @Size(min=1,max=50) String	groupDepartmentName
protected Integer	responseSizeLimit
protected @Valid SearchCriteriaRoutePointName[]	searchCriteriaRoutePointName

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

log

Constructor Summary

Constructors

Constructor	Description
GroupRoutePointGetInstanceListRequest()
GroupRoutePointGetInstanceListRequest(Group group)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static RoutePoint.GroupRoutePointGetInstanceListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Group	getGroup()
String	getGroupDepartmentName()
Integer	getResponseSizeLimit()
SearchCriteriaRoutePointName[]	getSearchCriteriaRoutePointName()
RoutePoint.GroupRoutePointGetInstanceListRequest	setGroup(Group group)
RoutePoint.GroupRoutePointGetInstanceListRequest	setGroupDepartmentName(String groupDepartmentName)
RoutePoint.GroupRoutePointGetInstanceListRequest	setResponseSizeLimit(Integer responseSizeLimit)
RoutePoint.GroupRoutePointGetInstanceListRequest	setSearchCriteriaRoutePointName(SearchCriteriaRoutePointName... searchCriteriaRoutePointName)

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, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setEcho, 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 Detail

group

@NotNull
@Valid
protected transient @NotNull @Valid Group group

groupDepartmentName

@Size(min=1,
      max=50)
protected @Size(min=1,max=50) String groupDepartmentName

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaRoutePointName

@Valid
protected @Valid SearchCriteriaRoutePointName[] searchCriteriaRoutePointName

Constructor Detail

GroupRoutePointGetInstanceListRequest

public GroupRoutePointGetInstanceListRequest()

GroupRoutePointGetInstanceListRequest

public GroupRoutePointGetInstanceListRequest(Group group)

Method Detail

setGroup

public RoutePoint.GroupRoutePointGetInstanceListRequest setGroup(Group group)

getGroup

public Group getGroup()

setGroupDepartmentName

public RoutePoint.GroupRoutePointGetInstanceListRequest setGroupDepartmentName(String groupDepartmentName)

getGroupDepartmentName

public String getGroupDepartmentName()

setResponseSizeLimit

public RoutePoint.GroupRoutePointGetInstanceListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaRoutePointName

public RoutePoint.GroupRoutePointGetInstanceListRequest setSearchCriteriaRoutePointName(SearchCriteriaRoutePointName... searchCriteriaRoutePointName)

getSearchCriteriaRoutePointName

public SearchCriteriaRoutePointName[] getSearchCriteriaRoutePointName()

getEmptyObject

public static RoutePoint.GroupRoutePointGetInstanceListRequest 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<RoutePoint.GroupRoutePointGetInstanceListResponse>