public class PortletTool extends Object implements org.sakaiproject.tool.api.Tool, Comparable
Tool is a utility class that implements the Tool interface.
| 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) *
|
| 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) |
| 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.
|
protected org.sakaiproject.tool.api.Tool.AccessSecurity m_accessSecurity
protected Set m_categories
protected String m_description
protected Properties m_finalConfig
protected String m_home
protected String m_id
protected Set m_keywords
protected Properties m_mutableConfig
protected String m_title
protected org.sakaiproject.tool.api.Tool m_tool
public PortletTool(org.apache.pluto.descriptors.portlet.PortletDD pdd,
org.apache.pluto.internal.InternalPortletContext portlet,
ServletContext portalContext,
org.sakaiproject.tool.api.Tool t)
public int compareTo(Object obj)
compareTo in interface Comparablepublic org.sakaiproject.tool.api.Tool.AccessSecurity getAccessSecurity()
getAccessSecurity in interface org.sakaiproject.tool.api.Toolpublic Set getCategories()
getCategories in interface org.sakaiproject.tool.api.Toolpublic String getDescription()
getDescription in interface org.sakaiproject.tool.api.Toolpublic Properties getFinalConfig()
getFinalConfig in interface org.sakaiproject.tool.api.Toolpublic String getHome()
getHome in interface org.sakaiproject.tool.api.Toolpublic String getId()
getId in interface org.sakaiproject.tool.api.Toolpublic Set getKeywords()
getKeywords in interface org.sakaiproject.tool.api.Toolpublic Properties getMutableConfig()
getMutableConfig in interface org.sakaiproject.tool.api.Toolpublic Properties getRegisteredConfig()
getRegisteredConfig in interface org.sakaiproject.tool.api.Toolpublic String getTitle()
getTitle in interface org.sakaiproject.tool.api.Toolpublic void setAccessSecurity(org.sakaiproject.tool.api.Tool.AccessSecurity access)
access - The new access security setting.public void setCategories(Set categories)
categories - The new categories set (Strings).public void setDescription(String description)
description - The description to set.public void setHome(String home)
public void setId(String id)
m_id - The m_id to set.public void setKeywords(Set keywords)
keywords - The new keywords set (Strings).public void setRegisteredConfig(Properties finalConfig, Properties mutableConfig)
config - The new registered configuration Properties.public void setTitle(String title)
title - The title to set.Copyright © 2003-2015 University of Michigan. All Rights Reserved.