IBM WebSphere Application ServerTM
Release 8

com.ibm.wbiserver.brules.mgmt.dtable
Interface TemplateInstanceExpression

All Superinterfaces:
BusinessRuleChangeDetector, BusinessRuleValidateable, java.io.Serializable

public interface TemplateInstanceExpression
extends BusinessRuleValidateable, BusinessRuleChangeDetector, java.io.Serializable

This interface represents an instance of a template used in an expression. It contains a list of values for each parameter defined in the corresponding template.


Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 java.lang.String getExpandedUserPresentation()
          Get the user presentation for this template instance express with the placeholders for the template parameters filled in with the actual value of the parameter.
 java.util.List<ParameterValue> getParameterValues()
          Get the values of all template parameters for this template instance rule.
 Template getTemplate()
          Get the template from which this template instance was derived.
 java.lang.String getUserPresentation()
          Get the user presentation for this template instance expression.
 
Methods inherited from interface com.ibm.wbiserver.brules.mgmt.BusinessRuleValidateable
validate
 
Methods inherited from interface com.ibm.wbiserver.brules.mgmt.BusinessRuleChangeDetector
hasChanges
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Method Detail

getParameterValues

java.util.List<ParameterValue> getParameterValues()
Get the values of all template parameters for this template instance rule.

Returns:
A List of ParameterValue objects, each of which represents the value of one template parameter. The list itself is unmodifiable. The value of an individual parameter can be changed by using the setValue method on the appropriate ParameterValue object.

getTemplate

Template getTemplate()
Get the template from which this template instance was derived.

Returns:
The template from which this template instance was derived.

getUserPresentation

java.lang.String getUserPresentation()
Get the user presentation for this template instance expression. The returned presentation string makes use of a convention where template parameters are represented by the index of the parameter in the template's parameter list surrounded by curly braces ('{' and '}'). For example, consider the following user presentation string: "set output1 to {0} and output2 to {1}". "{0}" represents the first parameter in the template and "{1}" represents the second parameter in the template.

This method is equivalent to calling getTemplate().getUserPresentation() on the TemplateInstanceExpression object.

Returns:
The user presentation for this template instance expression.

getExpandedUserPresentation

java.lang.String getExpandedUserPresentation()
Get the user presentation for this template instance express with the placeholders for the template parameters filled in with the actual value of the parameter. All of the template parameter placeholders (denoted by curly braces, '{' and '}') will be filled in with the actual parameter values specified in this template instance expression.

Returns:
The user presentation for this template instance expression with template parameter values filled in.

IBM WebSphere Application ServerTM
Release 8