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