org.marvelution.jira.plugins.jenkins.dao.SiteDAO 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.dao;

import java.util.List;

import org.marvelution.jira.plugins.jenkins.model.Site;

import com.atlassian.applinks.api.ApplicationId;

/**
 * {@link Site} Data Access Service
 *
 * @author Mark Rekveld
 * @since 1.0.0
 */
public interface SiteDAO {

	/**
	 * Get the {@link Site} by its Id
	 *
	 * @param siteId the Id of the {@link Site} to get
	 * @return the {@link Site}
	 */
	Site get(int siteId);

	/**
	 * Get the {@link Site} by its {@link ApplicationId}
	 *
	 * @param applicationId the {@link ApplicationId} of the {@link Site}
	 * @return the {@link Site}
	 */
	@Deprecated
	Site get(ApplicationId applicationId);

	/**
	 * Get all the {@link Site}s
	 *
	 * @return all the {@link Site}s
	 */
	List getAll();

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

	/**
	 * Delete the {@link Site} by its Id
	 *
	 * @param siteId the Id of the {@link Site} to delete
	 */
	void delete(int siteId);

}