Package com.uc4.communication.requests

Class GetComponentTemplates

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.GetComponentTemplates

All Implemented Interfaces:

Iterable<ComponentWorkflowObjectName>

public class GetComponentTemplates
extends XMLRequest
implements Iterable<ComponentWorkflowObjectName>

Creates a list of objects which are templates for Component Workflows of a specific component type.

Constructor Summary

Constructors

Constructor	Description
GetComponentTemplates(String type)	Creates a new GetComonentTemplates request.

Method Summary

Modifier and Type	Method	Description
protected void	createRequest(com.uc4.util.XMLDocument doc, Element request, ConnectionAttributes sessionInfo)	Creates the XML Document for the request.
protected String	getSrc()	Returns the request source.
protected void	handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)	Sub classes extract the values from the XML document and provide public getter methods.
Iterator<ComponentWorkflowObjectName>	iterator()
int	size()	Returns the number of templates which where returned by this request.

Methods inherited from class com.uc4.communication.requests.XMLRequest

assertClientZero, assertServerVersion, checkClient, checkID, checkLnr, checkNull, checkSelStatisticsPrivilege, checkSystemOverviewPrivilege, checkUC4ObjectEmptyName, checkUC4ObjectName, createNATFor, createNATRequest, emptyAttributes, getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, ignoreMessageBox, isAllowedInClientZero, send, setMessageBox, showQuarantineNotification

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

GetComponentTemplates

public GetComponentTemplates(String type)

Creates a new GetComonentTemplates request.

Parameters:

type - component or null to get all component templates

Method Details

getSrc

protected String getSrc()

Description copied from class: XMLRequest

Returns the request source. This method is used internally.

Specified by:

getSrc in class XMLRequest

Returns:

Source

createRequest

protected void createRequest(com.uc4.util.XMLDocument doc,
 Element request,
 ConnectionAttributes sessionInfo)

Description copied from class: XMLRequest

Creates the XML Document for the request. This method is used internally.

Specified by:

createRequest in class XMLRequest

Parameters:

doc - Document, used to create new Elements

request - Request Element - classes append information to this request element

sessionInfo - Information about the session

handleContent

protected void handleContent(com.uc4.util.XMLDocument doc,
 ConnectionAttributes session)

Description copied from class: XMLRequest

Sub classes extract the values from the XML document and provide public getter methods.

Overrides:

handleContent in class XMLRequest

Parameters:

doc - XML Document

session - Info about the user session

size

public int size()

Returns the number of templates which where returned by this request.

Returns:

Number of templates or 0 if this request has not been sent yet

iterator

public Iterator<ComponentWorkflowObjectName> iterator()

Specified by:

iterator in interface Iterable<ComponentWorkflowObjectName>