com.atlassian.jira.project.browse
Class BrowseProjectContext

java.lang.Object
  com.atlassian.jira.project.browse.BrowseProjectContext

All Implemented Interfaces:

BrowseContext

Direct Known Subclasses:

BrowseComponentContextImpl, BrowseVersionContextImpl

public class BrowseProjectContext
extends Object
implements BrowseContext

Context for BrowseProject when viewing a project.

Since:

v4.0

Field Summary

protected Project	project
protected TerminalClause	projectClause

Constructor Summary

BrowseProjectContext(com.atlassian.crowd.embedded.api.User user, Project project)

Method Summary

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.
protected TerminalClause	getProjectClause()
protected ProjectManager	getProjectManager()
String	getQueryString() Gets the URL query string for this context.
protected SearchService	getSearchService()
com.atlassian.crowd.embedded.api.User	getUser() The user browsing the project.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

project

protected Project project

projectClause

protected TerminalClause projectClause

Constructor Detail

BrowseProjectContext

public BrowseProjectContext(com.atlassian.crowd.embedded.api.User user,
                            Project project)

Method Detail

getProject

public Project getProject()

Description copied from interface: BrowseContext

The current projecet being browsed.

Specified by:

getProject in interface BrowseContext

Returns:

The current project.

getUser

public com.atlassian.crowd.embedded.api.User getUser()

Description copied from interface: BrowseContext

The user browsing the project.

Specified by:

getUser in interface BrowseContext

Returns:

The user browsing the project.

createQuery

public Query createQuery()

Description copied from interface: BrowseContext

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

Specified by:

createQuery in interface BrowseContext

Returns:

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

getProjectClause

protected TerminalClause getProjectClause()

getProjectManager

protected ProjectManager getProjectManager()

getSearchService

protected SearchService getSearchService()

getQueryString

public String getQueryString()

Description copied from interface: BrowseContext

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

Specified by:

getQueryString in interface BrowseContext

Returns:

the URL query string for this context.

createParameterMap

public Map<String,Object> createParameterMap()

Description copied from interface: BrowseContext

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

Specified by:

createParameterMap in interface BrowseContext

Returns:

a mapping from parameter name to domain object.

getContextKey

public String getContextKey()

Description copied from interface: BrowseContext

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.

Specified by:

getContextKey in interface BrowseContext

Returns:

a unique key for this context