net.ontopia.topicmaps.nav2.core
Interface FunctionIF

All Known Implementing Classes:

AbstractFunction, DisplayHierarchyFunction, Function, HelloWorldFunction

public interface FunctionIF

INTERNAL: Implemented by an object which represents a executable function within the navigator framework. It is comparable to a macro definition and can be used as an shortcut in a JSP-environment together with Ontopia's taglibs.

See logic:externalFunction for how to register your own function with the tag libraries. The function can later be executed using logic:call.

Method Summary

void	call(javax.servlet.jsp.PageContext pageContext, javax.servlet.jsp.tagext.TagSupport callingTag) Deprecated. 1.3.4. Use Object call(PageContext) instead.
java.util.Collection	execute(javax.servlet.jsp.PageContext pageContext, javax.servlet.jsp.tagext.TagSupport callingTag) INTERNAL: Executes this function in the specified context.
ModuleIF	getModule() Deprecated. This method is not used, and need not be implemented.
java.lang.String	getName() Deprecated. 1.3.4. Function names are now stored outside the function object itself.
java.util.Collection	getParameters() INTERNAL: Return the names of the parameters as an ordered Collection.
java.lang.String	getReturnVariableName() Deprecated. 1.3.4. Return function value from the Object call(PageContext) method instead.
JSPTreeNodeIF	getRootNode() Deprecated. This method is not used, and need not be implemented.

Method Detail

getParameters

java.util.Collection getParameters()

INTERNAL: Return the names of the parameters as an ordered Collection.

execute

java.util.Collection execute(javax.servlet.jsp.PageContext pageContext,
                             javax.servlet.jsp.tagext.TagSupport callingTag)
                             throws java.io.IOException,
                                    javax.servlet.jsp.JspException

INTERNAL: Executes this function in the specified context.

Returns:

Collection The function return value collection. If null is returned, no value will be given to the parent value accepting tag.

Throws:

java.io.IOException

javax.servlet.jsp.JspException

call

void call(javax.servlet.jsp.PageContext pageContext,
          javax.servlet.jsp.tagext.TagSupport callingTag)
          throws java.io.IOException,
                 javax.servlet.jsp.JspException

Deprecated. 1.3.4. Use Object call(PageContext) instead.

INTERNAL: Executes this function in the specified context.

Throws:

java.io.IOException

javax.servlet.jsp.JspException

getName

java.lang.String getName()

Deprecated. 1.3.4. Function names are now stored outside the function object itself.

INTERNAL: Gets the name of this function.

getReturnVariableName

java.lang.String getReturnVariableName()

Deprecated. 1.3.4. Return function value from the Object call(PageContext) method instead.

INTERNAL: Gets the name of the variable to which the return value of the function should be assigned to. Returns null if no return variable name was specified.

Since:

1.3

getRootNode

JSPTreeNodeIF getRootNode()

Deprecated. This method is not used, and need not be implemented.

INTERNAL: Gets the rode node of this Function.

getModule

ModuleIF getModule()

Deprecated. This method is not used, and need not be implemented.

INTERNAL: Gets the reference to the Module this function belongs to.