Package com.ptc.windchill.esi.ov

Interface ExpressionRendererDelegateIfc

All Known Implementing Classes:

DefaultExpressionRendererDelegate

public interface ExpressionRendererDelegateIfc

Delegate to validate expressionable/choicemappable/choicerule expressions and retrieve expression string from it. The class is intended to be extended by customizers to modify rendering of the expression as required and to add or modify validation for expressions during rendering process.
Supported API: true

Extendable: true

Method Summary

Modifier and Type	Method	Description
String	getExpression(Expressionable expressionable, OptionSet optionSet, ESITarget target, VdbBuilder builder)	Retrieve expression string for given expressionable object.
boolean	isValidated()	Check if given expressionables are validated before rendering.
void	validate(Collection<Persistable> expressionables, OptionSet optionSet, ESITarget target, VdbBuilder builder)	Validate expression on expressionables object. Supported API: true Extendable: true
void	validate(Expressionable expressionable, OptionSet optionSet, ESITarget target, VdbBuilder builder)	Validate expression on expressionable object.

Method Details

getExpression

String getExpression(Expressionable expressionable,
 OptionSet optionSet,
 ESITarget target,
 VdbBuilder builder)
              throws ExpressionRendererException

Retrieve expression string for given expressionable object.

Supported API: true

Extendable: true

Parameters:

expressionable - - The expressionable object for which expression needs to be rendered.

optionSet - - Assigned Option Set valid for expressionable object that can be used to formulate expression if required.

target - - The distibution target that is being processed in an ESI transaction

builder - - An instance of VdbBuilder that renderer is using

Returns:

- An expression representation to be rendered in ESI Response

Throws:

ExpressionRendererException

validate

void validate(Expressionable expressionable,
 OptionSet optionSet,
 ESITarget target,
 VdbBuilder builder)
       throws WTException

Validate expression on expressionable object.

Use multi object API for better performance and cache result instead of this single object API

Supported API: true

Extendable: true

Parameters:

expressionable - - The expressionable object for which expression needs to be validated.

optionSet - - Assigned Option Set valid for expressionable object that can be used to formulate expression if required.

target - - The distibution target that is being processed in an ESI transaction

builder - - An instance of VdbBuilder that renderer is using

Throws:

WTException - - The WTException for validation error.

validate

void validate(Collection<Persistable> expressionables,
 OptionSet optionSet,
 ESITarget target,
 VdbBuilder builder)
       throws WTException

Validate expression on expressionables object.

Supported API: true

Extendable: true

Parameters:

expressionables - - The collection expressionable objects for which expression needs to be validated.

optionSet - - Assigned Option Set valid for expressionable object that can be used to formulate expression if required.

target - - The distibution target that is being processed in an ESI transaction

builder - - An instance of VdbBuilder that renderer is usingget

builder -

Throws:

WTException

isValidated

boolean isValidated()

Check if given expressionables are validated before rendering.
Supported API: true

Returns:

- When expressions are validated by the delegate