org.marvelution.jira.plugins.jenkins.sync.SynchronizationOperation 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.sync;

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

/**
 * Synchronization Operation interface
 *
 * @author Mark Rekveld
 * @since 1.0.0
 */
public interface SynchronizationOperation {

	/**
	 * Returns the {@link OperationId} that uniquely identifies this operation
	 *
	 * @since 2.0.0
	 */
	OperationId getOperationId();

	/**
	 * Execute the Synchronization Operation
	 *
	 * @throws SynchronizationOperationException in case of synchronization errors
	 */
	void synchronize() throws SynchronizationOperationException;

	/**
	 * Returns the operation {@link SyncProgress}
	 */
	P getProgress();

}