Summary: Methods | [Expand All]
@PublicApi public interface

BrowseContext

com.atlassian.jira.project.browse.BrowseContext
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

The context of the Browse Project screen. This is passed into tabs to help them render themselves. It contains the current project and user, and for specific sub-classes more criteria. It is also responsible for adding criteria to SearchRequest to narrow their focus to the current context.

Summary

Public Methods
Map<String, Object> createParameterMap()
Creates a map of the context-specific parameters and their associated domain objects.
Query createQuery()
Creates a new Query that narrows it down to the current search context.
String getContextKey()
Contains a context unique that can be used to identify this context.
Project getProject()
The current projecet being browsed.
String getQueryString()
Gets the URL query string for this context.
User getUser()
The user browsing the project.

Public Methods

public Map<String, Object> createParameterMap ()

Creates a map of the context-specific parameters and their associated domain objects.

Returns
  • a mapping from parameter name to domain object.

public Query createQuery ()

Creates a new Query that narrows it down to the current search context. E.g. Project, Component, Version

Returns
  • A new Query that has a more refined search based on the current context.

public String getContextKey ()

Contains a context unique that can be used to identify this context. This is useful when storing things in the session on per context basis.

Returns
  • a unique key for this context

public Project getProject ()

The current projecet being browsed.

Returns
  • The current project.

public String getQueryString ()

Gets the URL query string for this context. Used to create links to navigator but still in this context.

Returns
  • the URL query string for this context.

public User getUser ()

The user browsing the project.

Returns
  • The user browsing the project.