com.atlassian.jira.portal
Interface Portlet

All Known Subinterfaces:

LazyLoadingPortlet, SearchRequestAwareChartPortlet

All Known Implementing Classes:

AbstractChartPortlet, AbstractRequiresUserPortlet, AbstractSearchResultsPortlet, AbstractTimeChartPortlet, AbstractVotesAndWatchesPortlet, AdminPortlet, AssignedToMePortlet, AverageAgeChartPortlet, CreatedVsResolvedChartPortlet, InProgressIssuesPortlet, IntroductionPortlet, MyVotesPortlet, MyWatchesPortlet, PieChartPortlet, PortletImpl, ProjectPortlet, ProjectsPortlet, ProjectStatsPortlet, ProjectTablePortlet, RecentlyCreatedChartPortlet, ReferencePortlet, ResolutionTimeChartPortlet, RoadMapPortlet, SavedFiltersPortlet, SearchRequestPortlet, StatsPortlet, TextPortlet, TimeSinceChartPortlet, TwoDimensionalStatsPortlet, UserIssuesPortlet

public interface Portlet

Method Summary

String	getCornerThumbnail()
String	getDescription()
PortletModuleDescriptor	getDescriptor()
String	getId()
String	getName()
ObjectConfiguration	getObjectConfiguration(Map map)
int	getPermission() Returns the permission required to view this portlet.
String	getTemplateLocation()
String	getThumbnailfile() The path to a thumbnail image of this portlet.
String	getViewHtml(PortletConfiguration portletConfiguration)
boolean	hasPermission() Returns true if the portlet requires a specific permission to view it.
void	init(PortletModuleDescriptor descriptor)

Method Detail

getId

String getId()

getName

String getName()

getDescription

String getDescription()

hasPermission

boolean hasPermission()

Returns true if the portlet requires a specific permission to view it.

Returns:

true If this portlet requires a permission i.e. getPermission != -1

getPermission

int getPermission()

Returns the permission required to view this portlet. See Permissions for symbolic constants.

Returns:

Returns a Permission. or -1 indicating no permission.

getThumbnailfile

String getThumbnailfile()

The path to a thumbnail image of this portlet.

Returns:

Path to image.

getCornerThumbnail

String getCornerThumbnail()

init

void init(PortletModuleDescriptor descriptor)

getTemplateLocation

String getTemplateLocation()

getViewHtml

String getViewHtml(PortletConfiguration portletConfiguration)

getObjectConfiguration

ObjectConfiguration getObjectConfiguration(Map map)
                                           throws ObjectConfigurationException

Throws:

ObjectConfigurationException

getDescriptor

PortletModuleDescriptor getDescriptor()