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, ResolutionTimeChartPortlet, RoadMapPortlet, SavedFiltersPortlet, SearchRequestPortlet, StatsPortlet, TextPortlet, TimeSinceChartPortlet, TwoDimensionalStatsPortlet, UserIssuesPortlet

public interface Portlet


Method Summary
 java.lang.String getCornerThumbnail()
           
 java.lang.String getDescription()
           
 PortletModuleDescriptor getDescriptor()
           
 java.lang.String getId()
           
 java.lang.String getName()
           
 ObjectConfiguration getObjectConfiguration(java.util.Map<java.lang.String,com.opensymphony.user.User> map)
           
 int getPermission()
          Returns the permission required to view 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()
          Returns true if the portlet requires a specific permission to view it.
 void init(PortletModuleDescriptor descriptor)
           
 

Method Detail

getId

java.lang.String getId()

getName

java.lang.String getName()

getDescription

java.lang.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

java.lang.String getThumbnailfile()
The path to a thumbnail image of this portlet.

Returns:
Path to image.

getCornerThumbnail

java.lang.String getCornerThumbnail()

init

void init(PortletModuleDescriptor descriptor)

getTemplateLocation

java.lang.String getTemplateLocation()

getViewHtml

java.lang.String getViewHtml(PortletConfiguration portletConfiguration)

getObjectConfiguration

ObjectConfiguration getObjectConfiguration(java.util.Map<java.lang.String,com.opensymphony.user.User> map)
                                           throws ObjectConfigurationException
Throws:
ObjectConfigurationException

getDescriptor

PortletModuleDescriptor getDescriptor()


Copyright © 2002-2010 Atlassian. All Rights Reserved.