com.ptc.windchill.esi.evt
Class ESISoapRequestRenderer

java.lang.Object
  com.ptc.windchill.esi.evt.ESISoapRequestRenderer

All Implemented Interfaces:

SoapRequestRenderer

Direct Known Subclasses:

ESIEventRenderer

public abstract class ESISoapRequestRenderer

extends Object

implements SoapRequestRenderer

Abstract class containing the implementation of the SoapRequestRenderer interface.

Supported API: true

Extendable: true

Field Summary

private StringBuffer	arguments
private static String	CLASSNAME
private ESIEvent	event
private static String	HEADER
private static String	RESOURCE
private static int	STRING_BUFFER__PAD_SIZE
private static String	TRAILER

Constructor Summary

ESISoapRequestRenderer()

Method Summary

String	asSoapRequest() This is a template method that forces subclasses to validate() and then executes their buildArguments() method.
protected abstract String	buildArguments() Abstract method forcing subclasses to create the XML fragment that will be enclosed in a SOAP envelope.
ESIEvent	getEvent() Gets the object for the association that plays role: event.
void	setEvent(ESIEvent a_Event) Sets the object for the association that plays role: event.
protected abstract void	validate() Abstract method forcing subclasses to ensure that their state is correct before attempting to build the request.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

arguments

private StringBuffer arguments

event

private ESIEvent event

HEADER

private static final String HEADER

See Also:

Constant Field Values

TRAILER

private static final String TRAILER

See Also:

Constant Field Values

STRING_BUFFER__PAD_SIZE

private static final int STRING_BUFFER__PAD_SIZE

See Also:

Constant Field Values

Constructor Detail

ESISoapRequestRenderer

public ESISoapRequestRenderer()

Method Detail

getEvent

public ESIEvent getEvent()

Gets the object for the association that plays role: event.

Supported API: true

Returns:

ESIEvent

setEvent

public void setEvent(ESIEvent a_Event)

Sets the object for the association that plays role: event.

Supported API: true

Specified by:

setEvent in interface SoapRequestRenderer

Parameters:

a_Event -

asSoapRequest

public final String asSoapRequest()
                           throws ESIEventException

This is a template method that forces subclasses to validate() and then executes their buildArguments() method. It stores the results in the arguments attribute.

Supported API: false

Specified by:

asSoapRequest in interface SoapRequestRenderer

Returns:

String

Throws:

ESIEventException

validate

protected abstract void validate()
                          throws ESIEventException

Abstract method forcing subclasses to ensure that their state is correct before attempting to build the request.

Supported API: false

Throws:

ESIEventException

buildArguments

protected abstract String buildArguments()
                                  throws ESIEventException

Abstract method forcing subclasses to create the XML fragment that will be enclosed in a SOAP envelope.

Supported API: false

Returns:

String

Throws:

ESIEventException