org.marvelution.jira.plugins.jenkins.services.BuildService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jira-jenkins-plugin Show documentation
JIRA Plugin to integrate Jenkins CI
There is a newer version: 2.3.1
/*
 * Copyright (c) 2012-present Marvelution B.V.
 *
 * 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 org.marvelution.jira.plugins.jenkins.services;

import java.util.Set;

import org.marvelution.jira.plugins.jenkins.model.Build;
import org.marvelution.jira.plugins.jenkins.model.Job;

import org.apache.commons.lang.math.Range;

/**
 * @author Mark Rekveld
 * @since 1.0.0
 */
public interface BuildService {

	/**
	 * Get a single {@link Build} by its ID
	 *
	 * @param buildId the {@link Build} id
	 * @return the {@link Build}
	 */
	Build get(int buildId);

	/**
	 * Get a single {@link Build} by its {@link Job} and build number
	 *
	 * @param job         the {@link Job} of the {@link Build} to get
	 * @param buildNumber the build number of the {@link Build}
	 * @return the {@link Build}, may be {@code null}
	 */
	Build get(Job job, int buildNumber);

	/**
	 * Get all the {@link Build}s by its {@link Job} and build number range
	 *
	 * @param job         the {@link Job} of the {@link Build} to get
	 * @param buildRange the range of build number of the {@link Build}
	 * @return the {@link Build}s, may be {@code empty}
	 * @since 1.4.8
	 */
	Set getAllInRange(Job job, Range buildRange);

	/**
	 * Get all {@link Build}s of the given {@link Job}
	 *
	 * @param job the {@link Job} to get all the builds for
	 * @return all the {@link Build}s that relate to the given {@link Job}
	 */
	Set getByJob(Job job);

	/**
	 * Get all the {@link Build}s related to the given JIRA issue key
	 *
	 * @param issueKey the JIRA issue key to get all the related {@link Build}s for
	 * @return all the {@link Build}s that relate to the given JIRA issue key
	 */
	Set getByIssueKey(String issueKey);

	/**
	 * Get all the {@link Build}s related to the given JIRA project key
	 *
	 * @param projectKey the JIRA project key to get all the related {@link Build}s for
	 * @return all the {@link Build}s that relate to the given JIRA project key
	 */
	Set getByProjectKey(String projectKey);

	/**
	 * Get all the builds that match the {@link BuildIssueFilter} given
	 *
	 * @param maxResults the maximum number of builds te return
	 * @param filter the {@link BuildIssueFilter}
	 * @return all the {@link Build}s that match the given filter
	 */
	Set getLatestBuildsByFilter(int maxResults, BuildIssueFilter filter);

	/**
	 * Get all related issue keys for the given {@link Build}
	 *
	 * @param build the {@link Build}
	 * @return the collection of issue keys
	 */
	Set getRelatedIssueKeys(Build build);

	/**
	 * Get the number of Issue Keys that are linked to the given {@link Build}
	 *
	 * @param build the {@link Build}
	 * @return the number of related issues (zero or higher)
	 */
	int getRelatedIssueKeyCount(Build build);

	/**
	 * Get all related project keys for the given {@link Build}
	 *
	 * @param build the {@link Build}
	 * @return the collection of project keys
	 */
	Set getRelatedProjectKeys(Build build);

	/**
	 * Link the given {@link Build} and issue key
	 *
	 * @param build    the {@link Build} to link to issue key
	 * @param issueKey the issue key to link
	 * @return {@code true} in case of a successful link, {@code false} otherwise
	 */
	boolean link(Build build, String issueKey);

	/**
	 * Save the given {@link Build}
	 *
	 * @param build the {@link Build} to save
	 * @return the saved {@link Build}
	 */
	Build save(Build build);

	/**
	 * Delete the {@link Build} given
	 *
	 * @param build the {@link Build} to delete
	 */
	void delete(Build build);

	/**
	 * delete all {@link Build}s related to the given {@link Job}
	 *
	 * @param job the {@link Job} of which to delete all the {@link Build}
	 */
	void deleteAllInJob(Job job);

	/**
	 * Mark the given {@link Build} as deleted on the remote site
	 *
	 * @param build the {@link Build} to mark as deleted
	 */
	void markAsDelete(Build build);

	/**
	 * Mark all the Builds of the given {@link Job} as deleted
	 *
	 * @param job the {@link Job} to mark all the builds from
	 */
	void markAllInJobAsDelete(Job job);

	/**
	 * Mark all the Builds up to the given number of the given {@link Job} as deleted
	 *
	 * @param job the {@link Job} to mark all the builds from
	 * @param buildNumber the build number till which the build should be marked as deleted
	 */
	void markAllInJobAsDelete(Job job, int buildNumber);
}