com.hp.octane.integrations.dto.scm.SCMChange Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of integrations-dto Show documentation
The newest version!
/**
 * Copyright 2017-2023 Open Text
 *
 * The only warranties for products and services of Open Text and
 * its affiliates and licensors (“Open Text”) are as may be set forth
 * in the express warranty statements accompanying such products and services.
 * Nothing herein should be construed as constituting an additional warranty.
 * Open Text shall not be liable for technical or editorial errors or
 * omissions contained herein. The information contained herein is subject
 * to change without notice.
 *
 * Except as specifically indicated otherwise, this document contains
 * confidential information and a valid license is required for possession,
 * use or copying. If this work is provided to the U.S. Government,
 * consistent with FAR 12.211 and 12.212, Commercial Computer Software,
 * Computer Software Documentation, and Technical Data for Commercial Items are
 * licensed to the U.S. Government under vendor's standard commercial license.
 *
 * 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.hp.octane.integrations.dto.scm;

import com.hp.octane.integrations.dto.DTOBase;
import com.hp.octane.integrations.dto.scm.impl.LineRange;

import java.io.Serializable;
import java.util.List;

/**
 * SCM Change DTO
 */

public interface SCMChange extends DTOBase, Serializable {

	String getType();

	SCMChange setType(String type);

	String getFile();

	List getAddedLines();

	void setAddedLines(List lines);

	void insertAddedLines(LineRange newRange);

	void insertDeletedLines(LineRange newRange);

	List getDeletedLines();

	void setDeletedLines(List lines);

	SCMChange setFile(String file);

	/**
	 * in case it's delete type (that came from renaming),
	 * we want to enrich the new renamed file as part of the SCMChange.
	 * this field will be filled as part of the lines enrichment process
	 * @param file file path
	 */
	void setRenamedToFile(String file);

	String getRenamedToFile();
}