org.sakaiproject.portal.service

Class PortletTool

java.lang.Object

org.sakaiproject.portal.service.PortletTool

All Implemented Interfaces:

Comparable, org.sakaiproject.tool.api.Tool

public class PortletTool
extends Object
implements org.sakaiproject.tool.api.Tool, Comparable

Tool is a utility class that implements the Tool interface.

Since:

Sakai 2.4

Version:

$Rev: 105079 $

Author:

ieb

Nested Class Summary

Nested classes/interfaces inherited from interface org.sakaiproject.tool.api.Tool

org.sakaiproject.tool.api.Tool.AccessSecurity

Field Summary

Fields

Modifier and Type	Field and Description
protected org.sakaiproject.tool.api.Tool.AccessSecurity	m_accessSecurity The access security.
protected Set	m_categories The set of categories.
protected String	m_description The description string.
protected Properties	m_finalConfig The configuration properties that are set by registration and may not be changed by confguration.
protected String	m_home Home destination.
protected String	m_id The well known identifier string.
protected Set	m_keywords The set of keywords.
protected Properties	m_mutableConfig The configuration properties that may be changed by configuration.
protected String	m_title The title string.
protected org.sakaiproject.tool.api.Tool	m_tool The parsed tool registration (if any) *

Fields inherited from interface org.sakaiproject.tool.api.Tool

FRAGMENT, HELPER_DONE_URL, HELPER_MESSAGE, NATIVE_URL, PLACEMENT, PLACEMENT_ID, PORTLET, TOOL, TOOL_SESSION

Constructor Summary

Constructors

Constructor and Description
PortletTool(org.apache.pluto.descriptors.portlet.PortletDD pdd, org.apache.pluto.internal.InternalPortletContext portlet, ServletContext portalContext, org.sakaiproject.tool.api.Tool t)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Object obj)
boolean	equals(Object obj)
org.sakaiproject.tool.api.Tool.AccessSecurity	getAccessSecurity()
Set	getCategories()
String	getDescription()
Properties	getFinalConfig()
String	getHome()
String	getId()
Set	getKeywords()
Properties	getMutableConfig()
Properties	getRegisteredConfig()
String	getTitle()
int	hashCode()
void	setAccessSecurity(org.sakaiproject.tool.api.Tool.AccessSecurity access) Set the access security.
void	setCategories(Set categories) Set the categories.
void	setDescription(String description) Set the description.
void	setHome(String home)
void	setId(String id) Set the id.
void	setKeywords(Set keywords) Set the keywords.
void	setRegisteredConfig(Properties finalConfig, Properties mutableConfig) Set the registered configuration.
void	setTitle(String title) Set the title.

Methods inherited from class java.lang.Object

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

Field Detail

m_accessSecurity

protected org.sakaiproject.tool.api.Tool.AccessSecurity m_accessSecurity

The access security.

m_categories

protected Set m_categories

The set of categories.

m_description

protected String m_description

The description string.

m_finalConfig

protected Properties m_finalConfig

The configuration properties that are set by registration and may not be changed by confguration.

m_home

protected String m_home

Home destination.

m_id

protected String m_id

The well known identifier string.

m_keywords

protected Set m_keywords

The set of keywords.

m_mutableConfig

protected Properties m_mutableConfig

The configuration properties that may be changed by configuration.

m_title

protected String m_title

The title string.

m_tool

protected org.sakaiproject.tool.api.Tool m_tool

The parsed tool registration (if any) *

Constructor Detail

PortletTool

public PortletTool(org.apache.pluto.descriptors.portlet.PortletDD pdd,
           org.apache.pluto.internal.InternalPortletContext portlet,
           ServletContext portalContext,
           org.sakaiproject.tool.api.Tool t)

Method Detail

compareTo

public int compareTo(Object obj)

Specified by:

compareTo in interface Comparable

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getAccessSecurity

public org.sakaiproject.tool.api.Tool.AccessSecurity getAccessSecurity()

Specified by:

getAccessSecurity in interface org.sakaiproject.tool.api.Tool

getCategories

public Set getCategories()

Specified by:

getCategories in interface org.sakaiproject.tool.api.Tool

getDescription

public String getDescription()

Specified by:

getDescription in interface org.sakaiproject.tool.api.Tool

getFinalConfig

public Properties getFinalConfig()

Specified by:

getFinalConfig in interface org.sakaiproject.tool.api.Tool

getHome

public String getHome()

Specified by:

getHome in interface org.sakaiproject.tool.api.Tool

getId

public String getId()

Specified by:

getId in interface org.sakaiproject.tool.api.Tool

getKeywords

public Set getKeywords()

Specified by:

getKeywords in interface org.sakaiproject.tool.api.Tool

getMutableConfig

public Properties getMutableConfig()

Specified by:

getMutableConfig in interface org.sakaiproject.tool.api.Tool

getRegisteredConfig

public Properties getRegisteredConfig()

Specified by:

getRegisteredConfig in interface org.sakaiproject.tool.api.Tool

getTitle

public String getTitle()

Specified by:

getTitle in interface org.sakaiproject.tool.api.Tool

hashCode

public int hashCode()

Overrides:

hashCode in class Object

setAccessSecurity

public void setAccessSecurity(org.sakaiproject.tool.api.Tool.AccessSecurity access)

Set the access security.

Parameters:

access - The new access security setting.

setCategories

public void setCategories(Set categories)

Set the categories.

Parameters:

categories - The new categories set (Strings).

setDescription

public void setDescription(String description)

Set the description.

Parameters:

description - The description to set.

setHome

public void setHome(String home)

setId

public void setId(String id)

Set the id.

Parameters:

m_id - The m_id to set.

setKeywords

public void setKeywords(Set keywords)

Set the keywords.

Parameters:

keywords - The new keywords set (Strings).

setRegisteredConfig

public void setRegisteredConfig(Properties finalConfig,
                       Properties mutableConfig)

Set the registered configuration.

Parameters:

config - The new registered configuration Properties.

setTitle

public void setTitle(String title)

Set the title.

Parameters:

title - The title to set.