public interface

Helper

com.atlassian.fisheye.plugin.web.helpers.Helper

Class Overview

Interface providing access to helper classes.

Summary

Public Methods
abstract ChangesetDataFE getChangeset()
abstract CommentData getComment()
abstract GlobalHelper getGlobal()
abstract UserData getParticipant()
abstract ProjectData getProject()
abstract ProjectService getProjectService()
abstract RepositoryHelper getRepository()
abstract RepositoryService getRepositoryService()
abstract HttpServletRequest getRequest()
abstract ReviewData getReview()
abstract ReviewItemData getReviewItem()
abstract ReviewService getReviewService()
abstract FileRevisionData getRevision()
abstract RevisionDataService getRevisionDataService()
abstract String urlEncode(String s)

Public Methods

public abstract ChangesetDataFE getChangeset ()

Returns
  • the ChangesetData object for the context changeset, or null if there is no changeset specific to this location

public abstract CommentData getComment ()

Returns
  • the CommentData object for this context, or null if there is no comment specific to this context

public abstract GlobalHelper getGlobal ()

Returns
  • the GlobalHelper object which contains global context data. This is always available.

public abstract UserData getParticipant ()

Returns
  • the UserData object for this location, which will be null unless this location is specific to a particular participant in a review. The WebItem will need to look at the ReviewData object returned by getReview() to determine what roles the user has.

public abstract ProjectData getProject ()

Returns
  • the ProjectData object for the context Crucible project, or null if there is no project specific to this location

public abstract ProjectService getProjectService ()

Returns
  • the ProjectService, which can be used in implementations of Conditions, for instance

public abstract RepositoryHelper getRepository ()

Returns
  • the RepositoryHelper object for the current context, or null if there is no repository specific to this context

public abstract RepositoryService getRepositoryService ()

Returns
  • the RepositoryService, which can be used in implementations of Conditions, for instance

public abstract HttpServletRequest getRequest ()

Returns
  • the current HttpServletRequest

public abstract ReviewData getReview ()

Returns
  • the ReviewData object for this location, or null if there is no review specific to this location

public abstract ReviewItemData getReviewItem ()

Returns
  • the ReviewItemData object for this context, or null if there is no review item is specific to this context

public abstract ReviewService getReviewService ()

Returns
  • the ReviewService, which can be used in implementations of Conditions, for instance

public abstract FileRevisionData getRevision ()

Returns
  • the FileRevisionData object for the context revision, or null if there is no revision specific to this location

public abstract RevisionDataService getRevisionDataService ()

Returns
  • the RevisionDataService, which can be used in implementations of Conditions, for instance

public abstract String urlEncode (String s)

Parameters
s a String that is yet to be URL encoded
Returns
  • a URL encoded String