1 package com.atlassian.sal.api.message;
2
3 /**
4 * Link to product specific help displayed in the UI.
5 * @since 2.4
6 */
7 public interface HelpPath
8 {
9 /**
10 * The key to the help item.
11 * This method should never return null. If there is no URL for a key or the key is null then the {@link HelpPathResolver}
12 * should return null from the getHelpPath() method.
13 * @return The key to the help item.
14 */
15 String getKey();
16
17 /**
18 * The full URL to the help content for this link.
19 * This should never return null. If there is no URL for a key then the {@link HelpPathResolver} should return null from
20 * the getHelpPath() method.
21 * @return The full URL to the help content for this link.
22 */
23 String getUrl();
24
25 /**
26 * Title attribute on the help link (the tooltip).
27 * @return Title attribute on the help link or null if there is none provided.
28 */
29 String getTitle();
30
31 /**
32 * Alternate text for the help icon.
33 * @return Alternate text for the help icon or null if there is none provided.
34 */
35 String getAlt();
36
37 /**
38 * Flag to indicate this is a local URL,
39 * A local path is within the application context.
40 * Clients may display local help links differently, especially for help that is generated dynamically.
41 * @return true for local help links.
42 */
43 boolean isLocal();
44 }