com.slickqa.client.apiparts.RetrieveUpdateDeleteApi 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.errors.SlickError;

/**
 * API for doing basic Retrieve, Update, and Delete for various types.
 * Create happens on the QueryAndCreateApi
 *
 * @author Jason Corbett
 * Created by jcorbett on 4/7/14.
 */
public interface RetrieveUpdateDeleteApi {

    /**
     * Retrieve a specific object.
     * @return The object returned from slick.
     * @throws SlickError on errors reported from the slick server.
     */
    public T get() throws SlickError;

    /**
     * Update an object.
     * @return The updated object as returned by slick.
     * @throws SlickError if the slick server returns an error.
     * @param update Update object
     */
    public T update(T update) throws SlickError;

    /**
     * Delete the specified object.
     * @throws SlickError if the slick server returns an error
     */
    public void delete() throws SlickError;
}