wt.templateutil.processor
Class AbstractProcessorService

java.lang.Object
  wt.templateutil.processor.AbstractProcessorService

All Implemented Interfaces:

ContextHolder, ProcessorService

Direct Known Subclasses:

NavigationProcessorService

public abstract class AbstractProcessorService

extends Object

implements ProcessorService

Provides a default, abstract implementation of ProcessorService so that developers can focus on subclasses business logic rather than trying to satisfy ProcessorService interface. The implementation of the ProcessorService methods in this abstract class are represntative of the standard usage of HTTPState to handle the information defined by the getters/settters. If you are going to implement a ProcessorService subclass, you should subclass the AbstractProcessorService unless you have an explicit reason to implement the ProcessorService interface differently. Even then, you should subclass AbstractProcessorService and only over those methods that require a non-default implementation.

Supported API: false

Extendable: false

Field Summary

private HTTPState	state Deprecated.
private static boolean	VERBOSE Deprecated.

Fields inherited from interface wt.templateutil.processor.ProcessorService

STATE

Fields inherited from interface wt.templateutil.processor.ContextHolder

CONTEXT_ACTION, CONTEXT_CLASS_NAME, CONTEXT_OBJ, CONTEXT_PROPERTIES, FORM_DATA, QUERY_DATA, RESPONSE_EXCEPTIONS, RESPONSE_FOOTERS, RESPONSE_HEADERS, RESPONSE_MESSAGES, RESPONSE_STRING, STATUS

Constructor Summary

AbstractProcessorService()
Deprecated.

Method Summary

void	addToResponseExceptions(Exception newException) Deprecated. Adds a LocalizableMessage message to the list of stackTraces that can be presented with the Windchill Script call
void	addToResponseFooters(LocalizableMessage newFooter) Deprecated. Adds a LocalizableMessage message to the list of localizable messages that can be presented with the Windchill Script call
void	addToResponseHeaders(LocalizableMessage newHeader) Deprecated. Adds a LocalizableMessage message to the list of localizable messages that can be presented with the Windchill Script call
void	addToResponseMessages(LocalizableMessage newMessage) Deprecated. Adds a LocalizableMessage message to the list of localizable messages that can be presented with the Windchill Script call
String	getContextAction() Deprecated. Gets the value of the attribute: CONTEXT_ACTION.
String	getContextClassName() Deprecated. Gets the value of the attribute: CONTEXT_CLASS_NAME.
Object	getContextObj() Deprecated. Gets the value of the attribute: CONTEXT_OBJ.
Properties	getContextProperties() Deprecated. Gets the value of the attribute: CONTEXT_PROPERTIES.
Properties	getFormData() Deprecated. Gets the value of the attribute: FORM_DATA.
Properties	getQueryData() Deprecated. Gets the value of the attribute: QUERY_DATA.
Vector	getResponseExceptions() Deprecated. Gets the value of the attribute: RESPONSE_EXCEPTIONS.
Vector	getResponseFooters() Deprecated. Gets the value of the attribute: RESPONSE_FOOTERS.
Vector	getResponseHeaders() Deprecated. Gets the value of the attribute: RESPONSE_HEADERS.
Vector	getResponseMessages() Deprecated. Gets the value of the attribute: RESPONSE_MESSAGES.
String	getResponseString() Deprecated. Gets the value of the attribute: RESPONSE_STRING.
HTTPState	getState() Deprecated. Gets the object for the association that plays role: STATE.
int	getStatus() Deprecated. Gets the value of the attribute: STATUS.
void	setContextAction(String a_ContextAction) Deprecated. Sets the value of the attribute: CONTEXT_ACTION.
void	setContextClassName(String a_ContextClassName) Deprecated. Sets the value of the attribute: CONTEXT_CLASS_NAME.
void	setContextObj(Object a_ContextObj) Deprecated. Sets the value of the attribute: CONTEXT_OBJ.
void	setContextProperties(Properties a_ContextProperties) Deprecated. Sets the value of the attribute: CONTEXT_PROPERTIES.
void	setFormData(Properties a_FormData) Deprecated. Sets the value of the attribute: FORM_DATA.
void	setQueryData(Properties a_QueryData) Deprecated. Sets the value of the attribute: QUERY_DATA.
void	setResponseExceptions(Vector a_ResponseExceptions) Deprecated. Sets the value of the attribute: RESPONSE_EXCEPTIONS.
void	setResponseFooters(Vector a_ResponseFooters) Deprecated. Sets the value of the attribute: RESPONSE_FOOTERS.
void	setResponseHeaders(Vector a_ResponseHeaders) Deprecated. Sets the value of the attribute: RESPONSE_HEADERS.
void	setResponseMessages(Vector a_ResponseMessages) Deprecated. Sets the value of the attribute: RESPONSE_MESSAGES.
void	setResponseString(String a_ResponseString) Deprecated. Sets the value of the attribute: RESPONSE_STRING.
void	setState(HTTPState state) Deprecated. Sets the object for the association that plays role: STATE.
void	setStatus(int a_Status) Deprecated. Sets the value of the attribute: STATUS.

Methods inherited from class java.lang.Object

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

Field Detail

state

private HTTPState state

Deprecated.

VERBOSE

private static final boolean VERBOSE

Deprecated.

Constructor Detail

AbstractProcessorService

public AbstractProcessorService()

Deprecated.

Method Detail

getState

public HTTPState getState()

Deprecated.

Description copied from interface: ProcessorService

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

Supported API: true

Specified by:

getState in interface ProcessorService

Returns:

HTTPState

setState

public void setState(HTTPState state)

Deprecated.

Description copied from interface: ProcessorService

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

Supported API: true

Specified by:

setState in interface ProcessorService

Parameters:

state -

getContextAction

public String getContextAction()

Deprecated.

Description copied from interface: ContextHolder

Gets the value of the attribute: CONTEXT_ACTION. Context Action is the name of the action of the current page

Supported API: true

Specified by:

getContextAction in interface ContextHolder

Returns:

String

setContextAction

public void setContextAction(String a_ContextAction)

Deprecated.

Description copied from interface: ContextHolder

Sets the value of the attribute: CONTEXT_ACTION. Context Action is the name of the action of the current page

Supported API: true

Specified by:

setContextAction in interface ContextHolder

Parameters:

a_ContextAction -

getContextObj

public Object getContextObj()

Deprecated.

Description copied from interface: ContextHolder

Gets the value of the attribute: CONTEXT_OBJ. Context Object is the reference object of the current page

Supported API: true

Specified by:

getContextObj in interface ContextHolder

Returns:

Object

setContextObj

public void setContextObj(Object a_ContextObj)

Deprecated.

Description copied from interface: ContextHolder

Sets the value of the attribute: CONTEXT_OBJ. Context Object is the reference object of the current page

Supported API: true

Specified by:

setContextObj in interface ContextHolder

Parameters:

a_ContextObj -

getContextClassName

public String getContextClassName()

Deprecated.

Description copied from interface: ContextHolder

Gets the value of the attribute: CONTEXT_CLASS_NAME. Context Object Name is the name of the class of the current page

Supported API: true

Specified by:

getContextClassName in interface ContextHolder

Returns:

String

setContextClassName

public void setContextClassName(String a_ContextClassName)

Deprecated.

Description copied from interface: ContextHolder

Sets the value of the attribute: CONTEXT_CLASS_NAME. Context Object Name is the name of the class of the current page

Supported API: true

Specified by:

setContextClassName in interface ContextHolder

Parameters:

a_ContextClassName -

getContextProperties

public Properties getContextProperties()

Deprecated.

Description copied from interface: ContextHolder

Gets the value of the attribute: CONTEXT_PROPERTIES.

Supported API: true

Specified by:

getContextProperties in interface ContextHolder

Returns:

Properties

setContextProperties

public void setContextProperties(Properties a_ContextProperties)

Deprecated.

Description copied from interface: ContextHolder

Sets the value of the attribute: CONTEXT_PROPERTIES.

Supported API: true

Specified by:

setContextProperties in interface ContextHolder

Parameters:

a_ContextProperties -

getResponseExceptions

public Vector getResponseExceptions()

Deprecated.

Description copied from interface: ContextHolder

Gets the value of the attribute: RESPONSE_EXCEPTIONS.

Supported API: true

Specified by:

getResponseExceptions in interface ContextHolder

Returns:

Vector

setResponseExceptions

public void setResponseExceptions(Vector a_ResponseExceptions)

Deprecated.

Description copied from interface: ContextHolder

Sets the value of the attribute: RESPONSE_EXCEPTIONS.

Supported API: true

Specified by:

setResponseExceptions in interface ContextHolder

Parameters:

a_ResponseExceptions -

getResponseFooters

public Vector getResponseFooters()

Deprecated.

Description copied from interface: ContextHolder

Gets the value of the attribute: RESPONSE_FOOTERS.

Supported API: true

Specified by:

getResponseFooters in interface ContextHolder

Returns:

Vector

setResponseFooters

public void setResponseFooters(Vector a_ResponseFooters)

Deprecated.

Description copied from interface: ContextHolder

Sets the value of the attribute: RESPONSE_FOOTERS.

Supported API: true

Specified by:

setResponseFooters in interface ContextHolder

Parameters:

a_ResponseFooters -

getResponseHeaders

public Vector getResponseHeaders()

Deprecated.

Description copied from interface: ContextHolder

Gets the value of the attribute: RESPONSE_HEADERS.

Supported API: true

Specified by:

getResponseHeaders in interface ContextHolder

Returns:

Vector

setResponseHeaders

public void setResponseHeaders(Vector a_ResponseHeaders)

Deprecated.

Description copied from interface: ContextHolder

Sets the value of the attribute: RESPONSE_HEADERS.

Supported API: true

Specified by:

setResponseHeaders in interface ContextHolder

Parameters:

a_ResponseHeaders -

getResponseMessages

public Vector getResponseMessages()

Deprecated.

Description copied from interface: ContextHolder

Gets the value of the attribute: RESPONSE_MESSAGES.

Supported API: true

Specified by:

getResponseMessages in interface ContextHolder

Returns:

Vector

setResponseMessages

public void setResponseMessages(Vector a_ResponseMessages)

Deprecated.

Description copied from interface: ContextHolder

Sets the value of the attribute: RESPONSE_MESSAGES.

Supported API: true

Specified by:

setResponseMessages in interface ContextHolder

Parameters:

a_ResponseMessages -

getResponseString

public String getResponseString()

Deprecated.

Description copied from interface: ContextHolder

Gets the value of the attribute: RESPONSE_STRING.

Supported API: true

Specified by:

getResponseString in interface ContextHolder

Returns:

String

setResponseString

public void setResponseString(String a_ResponseString)

Deprecated.

Description copied from interface: ContextHolder

Sets the value of the attribute: RESPONSE_STRING.

Supported API: true

Specified by:

setResponseString in interface ContextHolder

Parameters:

a_ResponseString -

getStatus

public int getStatus()

Deprecated.

Description copied from interface: ContextHolder

Gets the value of the attribute: STATUS.

Supported API: true

Specified by:

getStatus in interface ContextHolder

Returns:

int

setStatus

public void setStatus(int a_Status)

Deprecated.

Description copied from interface: ContextHolder

Sets the value of the attribute: STATUS.

Supported API: true

Specified by:

setStatus in interface ContextHolder

Parameters:

a_Status -

getFormData

public Properties getFormData()

Deprecated.

Description copied from interface: ContextHolder

Gets the value of the attribute: FORM_DATA. Form Data is the data present in the form of the current HTML page.

Supported API: true

Specified by:

getFormData in interface ContextHolder

Returns:

Properties

setFormData

public void setFormData(Properties a_FormData)

Deprecated.

Description copied from interface: ContextHolder

Sets the value of the attribute: FORM_DATA. Form Data is the data present in the form of the current HTML page.

Supported API: true

Specified by:

setFormData in interface ContextHolder

Parameters:

a_FormData -

getQueryData

public Properties getQueryData()

Deprecated.

Description copied from interface: ContextHolder

Gets the value of the attribute: QUERY_DATA. Query Data is the information present after the "?" mark on the URL of the current page.

Supported API: true

Specified by:

getQueryData in interface ContextHolder

Returns:

Properties

setQueryData

public void setQueryData(Properties a_QueryData)

Deprecated.

Description copied from interface: ContextHolder

Sets the value of the attribute: QUERY_DATA. Query Data is the information present after the "?" mark on the URL of the current page.

Supported API: true

Specified by:

setQueryData in interface ContextHolder

Parameters:

a_QueryData -

addToResponseExceptions

public void addToResponseExceptions(Exception newException)

Deprecated.

Description copied from interface: ContextHolder

Adds a LocalizableMessage message to the list of stackTraces that can be presented with the Windchill Script call

showResponseExceptions

Supported API: true

Specified by:

addToResponseExceptions in interface ContextHolder

Parameters:

newException -

addToResponseMessages

public void addToResponseMessages(LocalizableMessage newMessage)

Deprecated.

Description copied from interface: ContextHolder

Adds a LocalizableMessage message to the list of localizable messages that can be presented with the Windchill Script call

showResponseMessages

Supported API: true

Specified by:

addToResponseMessages in interface ContextHolder

Parameters:

newMessage -

addToResponseHeaders

public void addToResponseHeaders(LocalizableMessage newHeader)

Deprecated.

Description copied from interface: ContextHolder

Adds a LocalizableMessage message to the list of localizable messages that can be presented with the Windchill Script call

showResponseHeaders

Supported API: true

Specified by:

addToResponseHeaders in interface ContextHolder

Parameters:

newHeader -

addToResponseFooters

public void addToResponseFooters(LocalizableMessage newFooter)

Deprecated.

Description copied from interface: ContextHolder

Adds a LocalizableMessage message to the list of localizable messages that can be presented with the Windchill Script call

showResponseFooters

Supported API: true

Specified by:

addToResponseFooters in interface ContextHolder

Parameters:

newFooter -