Interface SimpleLinkFactoryModuleDescriptor

All Superinterfaces:
com.atlassian.plugin.ModuleDescriptor<SimpleLinkFactory>, com.atlassian.plugin.Resourced, com.atlassian.plugin.web.descriptors.WeightedDescriptor
All Known Implementing Classes:

public interface SimpleLinkFactoryModuleDescriptor
extends com.atlassian.plugin.ModuleDescriptor<SimpleLinkFactory>, com.atlassian.plugin.web.descriptors.WeightedDescriptor

Plugin in Module descriptor that defines a SimpleLinkFactory. This is used by the SimpleLinkManager to display a list of simple links.


Method Summary
 String getSection()
          The section that this list will be inserted into.
 boolean shouldBeLazy()
          Whether or not this should be lazily loaded.
Methods inherited from interface com.atlassian.plugin.ModuleDescriptor
destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModule, getModuleClass, getName, getParams, getPlugin, getPluginKey, hashCode, init, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion
Methods inherited from interface com.atlassian.plugin.Resourced
getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation
Methods inherited from interface com.atlassian.plugin.web.descriptors.WeightedDescriptor

Method Detail


boolean shouldBeLazy()
Whether or not this should be lazily loaded. This should be true if the list is expensive. Note that this can be ignored if the list does not support lazily loaded links.

true if the list is expensive to generate and should be loaded lazily if possible, false otherwise.


String getSection()
The section that this list will be inserted into. This usually refers to a WebSectionModuleDescriptor location + "/" + key. This should never return null.

The section that this list will be inserted into.

Copyright © 2002-2012 Atlassian. All Rights Reserved.