com.github.aistomin.jenkins.JobDetails Maven / Gradle / Ivy

Go to download
/**
 * Copyright (c) 2016, Istomin Andrei
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.github.aistomin.jenkins;

/**
 * Jenkins job details like: display name, description etc.
 *
 * @author Andrei Istomin ([email protected])
 * @version $Id$
 * @since 0.1
 */
public interface JobDetails {

    /**
     * Job's display name.
     *
     * @return Display name.
     * @throws Exception If error occurred.
     */
    String displayName() throws Exception;

    /**
     * Job's description.
     *
     * @return Description.
     * @throws Exception If error occurred.
     */
    String description() throws Exception;

    /**
     * Is job buildable?
     *
     * @return Is job buildable?
     * @throws Exception If error occurred.
     */
    Boolean buildable() throws Exception;
}