org.opencms.workplace.tools

Class CmsToolUserData

java.lang.Object

org.opencms.workplace.tools.CmsToolUserData

public class CmsToolUserData
extends java.lang.Object

Store for some administration view parameters, for each user, used by the CmsToolManager.

Since:

6.0.0

Constructor Summary

Constructors

Constructor and Description
CmsToolUserData() Default Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBaseTool(java.lang.String rootKey) Returns the base tool.
java.lang.String	getCurrentToolPath(java.lang.String rootKey) Returns the current tool path.
java.lang.String	getRootKey() Returns the root key.
void	setBaseTool(java.lang.String rootKey, java.lang.String baseTool) Sets the base tool.
void	setCurrentToolPath(java.lang.String rootKey, java.lang.String currentToolPath) Sets the current tool path.
void	setRootKey(java.lang.String key) Sets the root key.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsToolUserData

public CmsToolUserData()

Default Constructor.

Method Detail

getBaseTool

public java.lang.String getBaseTool(java.lang.String rootKey)

Returns the base tool.

Parameters:

rootKey - the tool root

Returns:

the base tool

getCurrentToolPath

public java.lang.String getCurrentToolPath(java.lang.String rootKey)

Returns the current tool path.

Parameters:

rootKey - the tool root

Returns:

the current tool path

getRootKey

public java.lang.String getRootKey()

Returns the root key.

Returns:

the root key

setBaseTool

public void setBaseTool(java.lang.String rootKey,
                        java.lang.String baseTool)

Sets the base tool.

Parameters:

rootKey - the tool root

baseTool - the base tool to set

setCurrentToolPath

public void setCurrentToolPath(java.lang.String rootKey,
                               java.lang.String currentToolPath)

Sets the current tool path.

Parameters:

rootKey - the tool root

currentToolPath - the current tool path to set

setRootKey

public void setRootKey(java.lang.String key)

Sets the root key.

Parameters:

key - the root key to set