File D:\maven-qcr-plugin-testsunitaires\qcr4java\jenkins-master\target\site\qc\core\src\main\java\hudson\model\DescriptorByNameOwner.java.html

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 */
24 package hudson.model;
25
26 /**
27 * Adds {@link #getDescriptorByName(String)} to bind {@link Descriptor}s to URL.
28 * Binding them at some specific object (instead of {@link jenkins.model.Jenkins}), allows
29 * {@link Descriptor}s to perform context-specific form field validation.
30 *
31 * <p>
32 * {@link Descriptor#getCheckUrl(String)} finds an ancestor with this interface
33 * and generates URLs against it.
34 *
35 * @author Kohsuke Kawaguchi
36 * @since 1.294
37 * @see Descriptor#getCheckUrl(String)
38 */
39 public interface DescriptorByNameOwner extends ModelObject {
40 /**
41 * Exposes all {@link Descriptor}s by its name to URL.
42 *
43 * <p>
44 * Implementation should always delegate to {@link jenkins.model.Jenkins#getDescriptorByName(String)}.
45 *
46 * @param id
47 * Either {@link Descriptor#getId()} (recommended) or the short name.
48 */
49 Descriptor getDescriptorByName(String id);
50 }
51