hudson.model.DescriptorByNameOwner Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hudson-core Show documentation

Contains the core Hudson code and view files to render HTML.

The newest version!

/* * The MIT License * * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ package hudson.model; /** * Adds {@link #getDescriptorByName(String)} to bind {@link Descriptor}s to URL. * Binding them at some specific object (instead of {@link Hudson}), allows * {@link Descriptor}s to perform context-specific form field validation. * * * {@link Descriptor#getCheckUrl(String)} finds an ancestor with this interface * and generates URLs against it. * * @author Kohsuke Kawaguchi * @since 1.294 * @see Descriptor#getCheckUrl(String) */ public interface DescriptorByNameOwner extends ModelObject { /** * Exposes all {@link Descriptor}s by its name to URL. * *

* Implementation should always delegate to {@link Hudson#getDescriptorByName(String)}. * * @param id * Either {@link Descriptor#getId()} (recommended) or the short name. */ Descriptor getDescriptorByName(String id); }