/hudson-core/src/main/java/hudson/search/SearchItem.java

 1/*
 2 * The MIT License
 3 * 
 4 * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
 5 * 
 6 * Permission is hereby granted, free of charge, to any person obtaining a copy
 7 * of this software and associated documentation files (the "Software"), to deal
 8 * in the Software without restriction, including without limitation the rights
 9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 * 
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 * 
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24package hudson.search;
25
26import hudson.model.Build;
27
28/**
29 * Represents an item reachable from {@link SearchIndex}.
30 *
31 * <p>
32 * The act of searching in this package is really a traversal of a directed graph.
33 * And in that notion, this interface represents an edge, not a node.
34 * So it's possible for single entity (let's say {@link Build}) to
35 * have multiple {@link SearchItem}s representing it (for example,
36 * a 'last successful build' search item and '#123' search item.)
37 *
38 * @author Kohsuke Kawaguchi
39 */
40public interface SearchItem {
41    /**
42     * Name of this item. This is matched against the query.
43     */
44    String getSearchName();
45    /**
46     * Returns the URL of this item relative to the parent {@link SearchItem}.
47     *
48     * @return
49     *      URL like "foo" or "foo/bar". The path can end with '/'.
50     *      The path that starts with '/' will be interpreted as the absolute path
51     *      (within the context path of Hudson.)
52     */
53    String getSearchUrl();
54
55    /**
56     * Returns the {@link SearchIndex} to further search into this item.
57     *
58     * @return
59     *      {@link SearchIndex#EMPTY} if this is a leaf.
60     */
61    SearchIndex getSearchIndex();
62}