This project has retired. For details please refer to its Attic page.

org.apache.cocoon.portal.tools
Class PortalTool

java.lang.Object
  org.apache.cocoon.portal.tools.PortalTool

public class PortalTool
extends Object

Represents a PortalTool

Version:

CVS $Id: PortalTool.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Field Summary

protected HashMap	functions
protected ArrayList	i18n
protected String	toolId
protected String	toolName

Constructor Summary

PortalTool(String toolName, String toolId, HashMap functions, ArrayList i18n)
Creates a new Portal Tool

Method Summary

PortalToolFunction	getFunction(String id) returns the function with the id id
Collection	getFunctions() returns a collection of available function
List	getI18n()
String	getId() returns the id of the tools
Collection	getInternalFunctions() not in use!
String	getName() returns the name of the tool
Collection	getPublicFunctions() return all public functions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

functions

protected final HashMap functions

toolName

protected final String toolName

toolId

protected final String toolId

i18n

protected final ArrayList i18n

Constructor Detail

PortalTool

public PortalTool(String toolName,
                  String toolId,
                  HashMap functions,
                  ArrayList i18n)

Creates a new Portal Tool

Parameters:

toolName -

toolId -

functions -

i18n -

Method Detail

getFunctions

public Collection getFunctions()

returns a collection of available function

getFunction

public PortalToolFunction getFunction(String id)

returns the function with the id id

Parameters:

id -

getInternalFunctions

public Collection getInternalFunctions()

not in use!

getPublicFunctions

public Collection getPublicFunctions()

return all public functions

getId

public String getId()

returns the id of the tools

getName

public String getName()

returns the name of the tool

getI18n

public List getI18n()