org.apache.cocoon.portal.tools
Class PortalToolFunction

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

All Implemented Interfaces:

PortalToolComponent

public class PortalToolFunction

extends Object

implements PortalToolComponent

Represents a function the user can call via the ui or the ToolManager.

Version:

$Id: PortalToolFunction.java 321068 2005-10-14 10:36:50Z cziegeler $

Constructor Summary

PortalToolFunction()
Constructor

PortalToolFunction(String name, String id, String function)
Constructor

Method Summary

String	getFunction() Returns the Functionname.
String	getId() Returns the id of the component
String	getName() Returns the name of the component
boolean	isInternal() not in use!
void	setFunction(String path) Sets the Functionname
void	setId(String id) Sets the id of the component
void	setInternal(boolean internal) not in use!
void	setName(String name) Sets the name of the component

Methods inherited from class java.lang.Object

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

Constructor Detail

PortalToolFunction

public PortalToolFunction()

Constructor

PortalToolFunction

public PortalToolFunction(String name,
                          String id,
                          String function)

Constructor

Parameters:

name - Function-Name

id - Id

function - Corresponding flow functino

Method Detail

getId

public String getId()

Description copied from interface: PortalToolComponent

Returns the id of the component

Specified by:

getId in interface PortalToolComponent

See Also:

PortalToolComponent.getId()

setId

public void setId(String id)

Description copied from interface: PortalToolComponent

Sets the id of the component

Specified by:

setId in interface PortalToolComponent

Parameters:

id -

See Also:

PortalToolComponent.setId(java.lang.String)

getName

public String getName()

Description copied from interface: PortalToolComponent

Returns the name of the component

Specified by:

getName in interface PortalToolComponent

See Also:

PortalToolComponent.getName()

setName

public void setName(String name)

Description copied from interface: PortalToolComponent

Sets the name of the component

Specified by:

setName in interface PortalToolComponent

Parameters:

name -

See Also:

PortalToolComponent.setName(java.lang.String)

getFunction

public String getFunction()

Returns the Functionname.

setFunction

public void setFunction(String path)

Sets the Functionname

Parameters:

path -

isInternal

public boolean isInternal()

not in use!

setInternal

public void setInternal(boolean internal)

not in use!

Parameters:

internal -