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!

/*******************************************************************************
 *
 * Copyright (c) 2004-2009 Oracle Corporation.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 * 
 *    Kohsuke Kawaguchi
 *
 *
 *******************************************************************************/ 

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);
}