com.atlassian.jira.portal
Interface Portlet

All Known Subinterfaces:
LazyLoadingPortlet
All Known Implementing Classes:
AbstractRequiresUserPortlet, AbstractSearchResultsPortlet, AbstractVotesAndWatchesPortlet, AdminPortlet, AssignedToMePortlet, InProgressIssuesPortlet, MyVotesPortlet, MyWatchesPortlet, PortletImpl, ProjectStatsPortlet, SavedFiltersPortlet, SearchRequestPortlet, StatsPortlet, TwoDimensionalStatsPortlet

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 a list of permissions for this portlet.
 String getTemplateLocation()
           
 String getThumbnailfile()
          The path to a thumbnail image of this portlet
 String getViewHtml(PortletConfiguration portletConfiguration)
           
 boolean hasPermission()
          Does the portlet have a permission set on it
 void init(PortletModuleDescriptor descriptor)
           
 

Method Detail

getId

String getId()

getName

String getName()

getDescription

String getDescription()

hasPermission

boolean hasPermission()
Does the portlet have a permission set on it

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

getPermission

int getPermission()
Returns a list of permissions for this portlet.

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

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-2007 Atlassian. All Rights Reserved.