com.atlassian.jira.portal
Interface Portlet

All Known Subinterfaces:
LazyLoadingPortlet
All Known Implementing Classes:
AbstractRequiresUserPortlet, AbstractSearchResultsPortlet, AbstractVotesAndWatchesPortlet, AdminPortlet, AssignedToMePortlet, InProgressIssuesPortlet, IntroductionPortlet, MyVotesPortlet, MyWatchesPortlet, PortletImpl, ProjectPortlet, ProjectsPortlet, ProjectStatsPortlet, ProjectTablePortlet, RoadMapPortlet, SavedFiltersPortlet, SearchRequestPortlet, StatsPortlet, TextPortlet, TwoDimensionalStatsPortlet, UserIssuesPortlet

public interface Portlet


Method Summary
 String getCornerThumbnail()
           
 String getDescription()
           
 PortletModuleDescriptor getDescriptor()
           
 String getId()
           
 String getName()
           
 com.atlassian.configurable.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

com.atlassian.configurable.ObjectConfiguration getObjectConfiguration(Map map)
                                                                      throws com.atlassian.configurable.ObjectConfigurationException
Throws:
com.atlassian.configurable.ObjectConfigurationException

getDescriptor

PortletModuleDescriptor getDescriptor()


Copyright © 2002-2008 Atlassian. All Rights Reserved.