com.atlassian.jira.plugin.versionpanel
Interface VersionContext

All Known Implementing Classes:
VersionContextImpl

public interface VersionContext

Maintains the current context for a version. This includes the version itself, version type (fixfor, affects, custom version field) and searchParameter (to be retrieved via the field's searcher.

Since:
v3.10

Method Summary
 SearchRequest createSearchRequest(SearchRequest sr)
          Creates a new search request for this version context.
 String getFieldId()
          Returns field id as String
 String getI18nKey()
          Returns message resource key for this version type
 Project getProject()
          convenience method to get the project from the version.
 String getQueryString()
          Returns a query string parameter to append to the IssueNavigator URL for field id.
 Version getVersion()
          Returns version
 

Method Detail

getProject

Project getProject()
convenience method to get the project from the version.

Returns:
a Project

getQueryString

String getQueryString()
Returns a query string parameter to append to the IssueNavigator URL for field id. It throws UnsupportedOperationException for not implemented field ids.

Returns:
a query string parameter to append to the IssueNavigator URL

getVersion

Version getVersion()
Returns version

Returns:
version

getFieldId

String getFieldId()
Returns field id as String

Returns:
field id as String

getI18nKey

String getI18nKey()
Returns message resource key for this version type

Returns:
message resource key for this version type

createSearchRequest

SearchRequest createSearchRequest(SearchRequest sr)
Creates a new search request for this version context. It clones the SearchRequest and appends the correct searchparameter for the version type. Throws UnsupportedOperationException for not implemented types.

Parameters:
sr - The old searchrequest. This will be cloned
Returns:
new search request for this version context


Copyright © 2002-2008 Atlassian. All Rights Reserved.