fr.cnes.doi.db

Class AbstractProjectSuffixDBHelper

java.lang.Object

fr.cnes.doi.db.AbstractProjectSuffixDBHelper

Direct Known Subclasses:

AbstractProjectSuffixPluginHelper

@Requirement(reqId="DOI_INTER_030",
             reqName="Interface avec la base de donn\u00e9es de gestion des suffixes DOI")
public abstract class AbstractProjectSuffixDBHelper
extends Object

Interface for handling the project suffix database.

Author:

Jean-Christophe Malapert (jean-christophe.malapert@cnes.fr)

Constructor Summary

Constructors

Constructor and Description
AbstractProjectSuffixDBHelper()

Method Summary

Modifier and Type	Method and Description
abstract boolean	addProjectSuffix(int projectID, String projectName) Adds a suffix project in the database.
abstract boolean	deleteProject(int projectID) Deletes a suffix project from the database.
abstract List<DOIUser>	getAllDOIUsersForProject(int doiSuffix) Returns the users related to a project.
abstract int	getIDFrom(String projectName) Returns the project suffix based on the project name.
abstract String	getProjectFrom(int projectID) Returns the project name based on the suffix project.
abstract List<DOIProject>	getProjects() Returns the database records.
abstract List<DOIProject>	getProjectsFromUser(String userName) Returns the projects related to a specific user.
abstract boolean	isExistID(int projectID) Tests is a suffix project exists in the database.
abstract boolean	isExistProjectName(String projectName) Tests is the project name exists in the database.
abstract boolean	renameProject(int projectID, String newProjectName) Rename a project in the database.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractProjectSuffixDBHelper

public AbstractProjectSuffixDBHelper()

Method Detail

addProjectSuffix

public abstract boolean addProjectSuffix(int projectID,
                                         String projectName)

Adds a suffix project in the database.

Parameters:

projectID - suffix project

projectName - project name

Returns:

True when the suffix project is added otherwise False

renameProject

public abstract boolean renameProject(int projectID,
                                      String newProjectName)

Rename a project in the database.

Parameters:

projectID - suffix project to be renamed

newProjectName - the new project name

Returns:

True when the project has been renamed otherwise False

deleteProject

public abstract boolean deleteProject(int projectID)

Deletes a suffix project from the database.

Parameters:

projectID - the suffix project

Returns:

True when the suffix project has been deleted otherwise False

isExistID

public abstract boolean isExistID(int projectID)

Tests is a suffix project exists in the database.

Parameters:

projectID - suffix project

Returns:

True when the suffix project exists otherwise False

isExistProjectName

public abstract boolean isExistProjectName(String projectName)

Tests is the project name exists in the database.

Parameters:

projectName - the project name

Returns:

True when the project name exists otherwise False.

getProjectFrom

public abstract String getProjectFrom(int projectID)
                               throws DOIDbException

Returns the project name based on the suffix project.

Parameters:

projectID - the suffix project

Returns:

the project name

Throws:

DOIDbException - when an error occurs

getIDFrom

public abstract int getIDFrom(String projectName)
                       throws DOIDbException

Returns the project suffix based on the project name.

Parameters:

projectName - the project name

Returns:

the suffix project

Throws:

DOIDbException - When an error occurs

getProjects

public abstract List<DOIProject> getProjects()
                                      throws DOIDbException

Returns the database records.

Returns:

the database records

Throws:

DOIDbException - When an error occurs

getProjectsFromUser

public abstract List<DOIProject> getProjectsFromUser(String userName)
                                              throws DOIDbException

Returns the projects related to a specific user.

Parameters:

userName - username

Returns:

the projected to an user

Throws:

DOIDbException - When an error occurs

getAllDOIUsersForProject

public abstract List<DOIUser> getAllDOIUsersForProject(int doiSuffix)
                                                throws DOIDbException

Returns the users related to a project.

Parameters:

doiSuffix - project

Returns:

the users

Throws:

DOIDbException - When an error occurs.