com.atlassian.jira.portal
Interface Portlet

All Known Implementing Classes:

PortletImpl

public interface Portlet

Method Summary

java.lang.String	getCornerThumbnail()
java.lang.String	getDescription()
PortletModuleDescriptor	getDescriptor()
java.lang.String	getId()
java.lang.String	getName()
com.atlassian.configurable.ObjectConfiguration	getObjectConfiguration(java.util.Map map)
int	getPermission() Returns a list of permissions for this portlet.
java.lang.String	getTemplateLocation()
java.lang.String	getThumbnailfile() The path to a thumbnail image of this portlet
java.lang.String	getViewHtml(PortletConfiguration portletConfiguration)
boolean	hasPermission() Does the portlet have a permission set on it
void	init(PortletModuleDescriptor descriptor)

Method Detail

getId

public java.lang.String getId()

getName

public java.lang.String getName()

getDescription

public java.lang.String getDescription()

hasPermission

public boolean hasPermission()

Does the portlet have a permission set on it

Returns:

true If this user has a permission e.g. getPermission == -1

getPermission

public int getPermission()

Returns a list of permissions for this portlet.

Returns:

Returns a Permission. -1 indicates no permission so viewable by everyone

getThumbnailfile

public java.lang.String getThumbnailfile()

The path to a thumbnail image of this portlet

Returns:

Path to image

getCornerThumbnail

public java.lang.String getCornerThumbnail()

init

public void init(PortletModuleDescriptor descriptor)

getTemplateLocation

public java.lang.String getTemplateLocation()

getViewHtml

public java.lang.String getViewHtml(PortletConfiguration portletConfiguration)

getObjectConfiguration

public com.atlassian.configurable.ObjectConfiguration getObjectConfiguration(java.util.Map map)
                                                                      throws com.atlassian.configurable.ObjectConfigurationException

Throws:

com.atlassian.configurable.ObjectConfigurationException

getDescriptor

public PortletModuleDescriptor getDescriptor()