Package 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

    Modifier and Type
    Method
    Description
    void
    call(javax.servlet.jsp.PageContext pageContext, javax.servlet.jsp.tagext.TagSupport callingTag)
    Deprecated.
    1.3.4.
    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.
    String
    getName()
    Deprecated.
    1.3.4.
    Collection
    getParameters()
    INTERNAL: Return the names of the parameters as an ordered Collection.
    String
    getReturnVariableName()
    Deprecated.
    1.3.4.
    JSPTreeNodeIF
    getRootNode()
    Deprecated.
    This method is not used, and need not be implemented.

  • Method Details

    • getParameters

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

    • execute

      Collection execute(javax.servlet.jsp.PageContext pageContext, javax.servlet.jsp.tagext.TagSupport callingTag) throws 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:
      IOException
      javax.servlet.jsp.JspException

    • call

      @Deprecated void call(javax.servlet.jsp.PageContext pageContext, javax.servlet.jsp.tagext.TagSupport callingTag) throws IOException, javax.servlet.jsp.JspException
      Deprecated.
      1.3.4. Use Object call(PageContext) instead.
      INTERNAL: Executes this function in the specified context.
      Throws:
      IOException
      javax.servlet.jsp.JspException

    • getName

      @Deprecated String getName()
      Deprecated.
      1.3.4. Function names are now stored outside the function object itself.
      INTERNAL: Gets the name of this function.

    • getReturnVariableName

      @Deprecated 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

      @Deprecated JSPTreeNodeIF getRootNode()
      Deprecated.
      This method is not used, and need not be implemented.
      INTERNAL: Gets the rode node of this Function.

    • getModule

      @Deprecated ModuleIF getModule()
      Deprecated.
      This method is not used, and need not be implemented.
      INTERNAL: Gets the reference to the Module this function belongs to.