com.slickqa.client.apiparts.ProjectApi Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of slickqa-java-client Show documentation

Java client api for the slick test management tool.

The newest version!

package com.slickqa.client.apiparts;

import com.slickqa.client.model.Component;
import com.slickqa.client.model.Project;
import com.slickqa.client.model.Release;

/**
 * The project api, has more than the simple RetrieveUpdateDeleteApi as it deals with releases, and components.
 *
 * Created by jcorbett on 4/6/14.
 */
public interface ProjectApi extends RetrieveUpdateDeleteApi {
    /**
     * Query for all the releases, no filtering.
     * @return QueryAndCreateApi
     */
    public QueryAndCreateApi releases();

    /**
     * Use a specific release.
     *
     * @param idOrName The id or name of the release.
     * @return ReleaseApi
     */
    public ReleaseApi release(String idOrName);

    /**
     * Query for all the components belonging to the specified project.
     * @return QueryAndCreateApi
     */
    public QueryAndCreateApi components();

    /**
     * Retrieve, update, or delete a specific component.
     * @param idOrName the id or name of the component.
     * @return RetrieveUpdateDeleteApi
     */
    public RetrieveUpdateDeleteApi component(String idOrName);
}