com.katalon.platform.api.controller.TestSuiteCollectionController Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com.katalon.platform Show documentation
There is a newer version: 1.0.5
package com.katalon.platform.api.controller;

import java.util.List;

import com.katalon.platform.api.exception.ResourceException;
import com.katalon.platform.api.model.ProjectEntity;
import com.katalon.platform.api.model.TestSuiteCollectionEntity;
import com.katalon.platform.api.service.ProjectManager;

/**
 * TestSuiteCollectionController is a unique KS Controller to help KS plugins can
 * manipulate {@link TestSuiteCollectionEntity} in the file system.
 * 
 * @see #getAllTestSuiteCollectionsInProject(ProjectEntity project)
 * @see #getTestSuiteCollection(ProjectEntity project, String
 *      testSuiteCollectionId)
 * @see #addTestSuiteToTestSuiteCollection(ProjectEntity project, String
 *      testSuiteCollectionId, String testSuiteId)
 * 
 * @since 1.0.11
 */
public interface TestSuiteCollectionController extends Controller {

	/**
	 * Return all instances of TestSuiteCollectionEntity within the specified
	 * project
	 * 
	 * @param project
	 *            an instance of working project. The current working project
	 *            can retrieve by using
	 *            {@link ProjectManager#getCurrentProject()}.
	 * @return A list of all instances of TestSuiteCollectionEntity
	 * @throws ResourceException
	 *             if KS could not read or access any of the instances
	 * 
	 * @since 1.0.11
	 * 
	 */
	List getAllTestSuiteCollectionsInProject(ProjectEntity project) throws ResourceException;

	/**
	 * Returns an instance of TestSuiteCollectionEntity of the given
	 * project by the given testSuiteCollectionId
	 * 
	 * @param project
	 *            an instance of working project. The current working project
	 *            can retrieve by using
	 *            {@link ProjectManager#getCurrentProject()}.
	 * 
	 * @param testSuiteCollectionId
	 *            id of TestSuiteCollectionEntity
	 * @return an instance of TestSuiteCollectionEntity
	 * @throws ResourceException
	 *             if KS could not read or access test suite.
	 * 
	 * @since 1.0.11
	 */
	TestSuiteCollectionEntity getTestSuiteCollection(ProjectEntity project, String testSuiteCollectionId)
			throws ResourceException;

	/**
	 * Allows you to add an existing Test Suite into a Test Suite Collection
	 * 
	 * @param project
	 *            an instance of working project. The current working project
	 *            can retrieve by using
	 *            {@link ProjectManager#getCurrentProject()}.
	 * 
	 * @param testSuiteCollectionId
	 *            id of TestSuiteCollectionEntity
	 * @param testSuiteId
	 *            id of the TestSuiteEntity
	 * @return An instance of TestSuiteCollectionEntity which has the specified
	 *         Test Suite
	 * @throws ResourceException
	 *             if KS cannot read or access either the test suite collection
	 *             or the test suite
	 * @since 1.0.11           
	 */
	TestSuiteCollectionEntity addTestSuiteToTestSuiteCollection(ProjectEntity project, String testSuiteCollectionId,
			String testSuiteId) throws ResourceException;
}