com.atlassian.jira.plugin.webfragment
Interface SimpleLinkFactory

All Known Implementing Classes:

AdminHistoryLinkFactory, AttachmentSortingOptionsFactory, AttachmentSortingOrderOptionsFactory, CurrentSearchLinkFactory, FavouriteDashboardLinkFactory, FavouriteFilterLinkFactory, IssueHistoryLinkFactory, LegacyAdminLinkFactory, ProjectHistoryLinkFactory, SubTaskViewOptionsFactory, TransitionLinkFactory

@PublicSpi
public interface SimpleLinkFactory

A factory that produces a list of SimpleLink objects.

Since:

v4.0

Method Summary

List<SimpleLink>	getLinks(com.atlassian.crowd.embedded.api.User user, Map<String,Object> params) Generates a list of SimpleLink objects.
void	init(SimpleLinkFactoryModuleDescriptor descriptor) Initialization method for the factory.

Method Detail

init

void init(SimpleLinkFactoryModuleDescriptor descriptor)

Initialization method for the factory. Used to retrieve information off the module descriptor

Parameters:

descriptor - The descriptor responsible for defining this factory.

getLinks

@Nonnull
List<SimpleLink> getLinks(com.atlassian.crowd.embedded.api.User user,
                                  Map<String,Object> params)

Generates a list of SimpleLink objects.

Parameters:

user - The user this list is being generated for.

Returns:

a list of SimpleLink objects tailored for the user.