COM.FutureTense.Interfaces

Interface IXMLBodyTag

All Superinterfaces:

Seed

public interface IXMLBodyTag
extends Seed

This interface defines the methods that a class must implement in order to create a custom XML body tag. It works in the same general way as the IDynamicTag interface, but it uses different method names that are unlikely to collide with JSP, should a class choose to implement both BodyTagSupport and IXMLBodyTag. Important note: While this interface does indeed extend the Seed interface, the Seed.Execute(FTValList vIn, FTValList vOut) method will never be invoked. More importantly, the interface will be changed to no longer extend Seed in a future version. No implementations should under any circumstances depend on the fact that this interface extends the Seed interface.

Since:

7-Nov-2005 6:05:50 PM

Field Summary

Fields

Modifier and Type	Field and Description
static int	EVALUATE_BODY Define a return code to indicate that the body should be evaluated
static int	EVALUATE_COMPLETE Define a return code to indicate that evaluation is complete

Fields inherited from interface COM.FutureTense.XML.Template.Seed

returnString

Method Summary

Modifier and Type	Method and Description
int	endTag(ICS ics, String sTagName, FTValList vIn) Method to evaluate the end tag of a dynamic tag
String	Execute(FTValList vIn, FTValList vOut) Deprecated. The execute method of this interface will never be invoked and it should always return null.
boolean	isCaseSensitive() Method to see if the name and attributes are case sensitive
boolean	isReplaceRequired() Method to see if the attributes should have variables replaced
void	setIXMLBodyTagParent(IXMLBodyTag parent) Method to set the parent of a tag
int	startTag(ICS ics, String sTagName, FTValList vIn, String sCData) Method to evaluate the start tag of a dynamic tag

Field Detail

EVALUATE_COMPLETE

static final int EVALUATE_COMPLETE

Define a return code to indicate that evaluation is complete

See Also:

Constant Field Values

EVALUATE_BODY

static final int EVALUATE_BODY

Define a return code to indicate that the body should be evaluated

See Also:

Constant Field Values

Method Detail

endTag

int endTag(ICS ics,
           String sTagName,
           FTValList vIn)

Method to evaluate the end tag of a dynamic tag

Parameters:

ics - interface to Content Server

sTagName - name of the tag

vIn - input attributes

Returns:

return EVALUATE_BODY to continue body and end tag evaluation or EVALUATE_COMPLETE to complete evaluation.

isCaseSensitive

boolean isCaseSensitive()

Method to see if the name and attributes are case sensitive

Returns:

true to leave case false to force lower

isReplaceRequired

boolean isReplaceRequired()

Method to see if the attributes should have variables replaced

Returns:

true to replace variables in attributes otherwise return false

setIXMLBodyTagParent

void setIXMLBodyTagParent(IXMLBodyTag parent)

Method to set the parent of a tag

Parameters:

parent - parent tag class

startTag

int startTag(ICS ics,
             String sTagName,
             FTValList vIn,
             String sCData)

Method to evaluate the start tag of a dynamic tag

Parameters:

ics - interface to Content Server

sTagName - name of the tag

vIn - input attributes

sCData - compressed child tags

Returns:

return EVALUATE_BODY to evaluate the body and end tag or EVALUATE_COMPLETE to skip the body and end tag evaluation.

Execute

String Execute(FTValList vIn,
               FTValList vOut)

Deprecated. The execute method of this interface will never be invoked and it should always return null.

The execute method is deprecated and will never be executed.

Specified by:

Execute in interface Seed

Parameters:

vIn - a FTValList with input variables.

vOut - a FTValList output variables to to set within script engine scope. Note that the script engine returns errors as less than zero values.

Returns:

String value to stream back from within script engine scope (null is fine)