com.atlassian.jira.hints
Interface HintManager

All Known Implementing Classes:
DefaultHintManager

public interface HintManager

Hint manager responsible for providing JIRA usage hints displayed to the users.

Since:
v4.2

Nested Class Summary
static class HintManager.Context
          A number of different contexts that hints may be displayed for.
 
Method Summary
 List<Hint> getAllHints(com.atlassian.crowd.embedded.api.User user, JiraHelper helper)
          Get all hints visible in given user context.
 Hint getHintForContext(com.atlassian.crowd.embedded.api.User remoteUser, JiraHelper jiraHelper, HintManager.Context context)
          Given a valid HintManager.Context this method returns a random link for that context.
 Hint getRandomHint(com.atlassian.crowd.embedded.api.User user, JiraHelper jiraHelper)
          Get random hint visible in given user context.
 

Method Detail

getRandomHint

Hint getRandomHint(com.atlassian.crowd.embedded.api.User user,
                   JiraHelper jiraHelper)
Get random hint visible in given user context.

Parameters:
user - current user
jiraHelper - JIRA helper
Returns:
random hint

getAllHints

List<Hint> getAllHints(com.atlassian.crowd.embedded.api.User user,
                       JiraHelper helper)
Get all hints visible in given user context.

Parameters:
user - current user
helper - JIRA helper
Returns:
all hints accessible to the user

getHintForContext

Hint getHintForContext(com.atlassian.crowd.embedded.api.User remoteUser,
                       JiraHelper jiraHelper,
                       HintManager.Context context)
Given a valid HintManager.Context this method returns a random link for that context. May be null if no hints exist for the context specified.

Parameters:
remoteUser - The current user
jiraHelper - JIRA helper
context - The context to display a hint for
Returns:
A random hint for the context specified or null if none exist


Copyright © 2002-2012 Atlassian. All Rights Reserved.