com.greenpepper.server.domain.dao.RepositoryDao Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of greenpepper-server Show documentation
There is a newer version: 4.2.4
package com.greenpepper.server.domain.dao;

import java.util.List;

import com.greenpepper.server.GreenPepperServerException;
import com.greenpepper.server.domain.Repository;
import com.greenpepper.server.domain.RepositoryType;
import com.greenpepper.server.domain.component.ContentType;

/**
 * RepositoryDao interface.
 *
 * @author oaouattara
 * @version $Id: $Id
 */
public interface RepositoryDao
{
    /**
     * Retrieves the Repository.
     * If none found an GreenPepperServerException is thrown.
     * 
     *
     * @return the Repository.
     * @param repositoryUID a {@link java.lang.String} object.
     */
    public Repository getByUID(String repositoryUID);

    /**
     * Retrieves the Repository.
     * If none found an GreenPepperServerException is thrown.
     * 
     *
     * @param projectName a {@link java.lang.String} object.
     * @param repositoryName a {@link java.lang.String} object.
     * @return the Repository.
     */
    public Repository getByName(String projectName, String repositoryName);

    /**
     * Retrieves all the registered Repositories.
     * 
     *
     * @return the repositories
     */
    public List getAll();

    /**
     * Retrieves all the registered Repositories for a project.
     * 
     *
     * @param projectName a {@link java.lang.String} object.
     * @return all the registered Repositories for a project.
     */
    public List getAll(String projectName);

    /**
     * Retrieves all the registered Test Repositories for  project.
     * 
     *
     * @param projectName a {@link java.lang.String} object.
     * @return the Tests repositories
     */
    public List getAllTestRepositories(String projectName);

    /**
     * Retrieves all the registered Requirement Repositories for a project.
     * 
     *
     * @param projectName a {@link java.lang.String} object.
     * @return the Requirements repositories
     */
    public List getAllRequirementRepositories(String projectName);


    /**
     * Retrieve all the repository of a certain type.
     *
     * @param contentType a {@link com.greenpepper.server.domain.component.ContentType} object.
     * @return a {@link java.util.List} object.
     */
    public List getAllRepositories(ContentType contentType);

    /**
     * Retrieves the repository type by name.
     * 
     *
     * @param repositoryTypeName a {@link java.lang.String} object.
     * @return the repository type.
     */
    public RepositoryType getTypeByName(String repositoryTypeName);

    /**
     * Creates a new Repository.
     * 
     *
     * @param newRepository a {@link com.greenpepper.server.domain.Repository} object.
     * @return the created repository
     * @throws com.greenpepper.server.GreenPepperServerException if any.
     */
    public Repository create(Repository newRepository) throws GreenPepperServerException;

    /**
     * Updates the Repository.
     * 
     *
     * @param repository a {@link com.greenpepper.server.domain.Repository} object.
     * @throws com.greenpepper.server.GreenPepperServerException if any.
     */
    public void update(Repository repository) throws GreenPepperServerException;
    
    /**
     * Removes the repository if this one doesnt hold any specifications
     *
     * @param repositoryUid a {@link java.lang.String} object.
     * @throws com.greenpepper.server.GreenPepperServerException if any.
     */
    public void remove(String repositoryUid) throws GreenPepperServerException;

    /**
     * Retrieves all available RepositoryTypes.
     * 
     *
     * @return a {@link java.util.List} object.
     */
    public List getAllTypes();
    
    /**
     * Create a new Repository Type
     * 
     *
     * @return the Requirement type created
     * @param repositoryType a {@link com.greenpepper.server.domain.RepositoryType} object.
     */
    public RepositoryType create(RepositoryType repositoryType);

}