com.jamasoftware.contour.dao
Interface BaseLineDao

public interface BaseLineDao

Data access object for baseline.

Author:

sean

Method Summary

void	deleteBaseLine(BaseLine baseLine) Logically deletes a BaseLine.
void	deleteBaseLineGroup(java.lang.Integer scopeId, java.lang.Integer refId, java.lang.Integer projectId) Deletes the "Baseline Group" that all have the given scope id and ref id This function logically deletes this group and baseline from the database.
BaseLine	getBaseLine(java.lang.Integer baseLineId)
java.util.List<BaseLine>	getBaseLineListForProject(java.lang.Integer projectId) Gets a list of active BaseLines.
java.util.List<BaseLine>	getBaseListListByFilter(java.lang.Integer filterId) Gets all baselines associated with a filter
java.util.List<java.lang.Integer>	getDocumentIds(java.lang.Integer baselineId) Gets ids of the documents that are assosciated with a baseline.
java.util.List<BaseLine>	getFullBaseLineListForProject(java.lang.Integer projectId) Gets a full list of BaseLines, including active AND inactive ones.
int	getNumberActiveBaseLines(java.lang.Integer scopeId, java.lang.Integer refId) Gets the number of BaseLines with the given scope and ref id, and that are marked active.
int	getNumberDocumentsChanged(java.lang.Integer baseLineId) Gets the number of Documents that were versioned by this BaseLine that now have a more recent Version.
java.util.List<Signature>	getSignaturesForBaseLine(java.lang.Integer baselineId) Gets the signatures associated with a BaseLine (and any signatures associated with a Revision that uses the BaseLine.
void	physicallyDeleteBaseLine(BaseLine baseLine) Physically deletes this BaseLine from the database.
void	saveBaseLine(BaseLine baseLine)

Method Detail

getBaseLineListForProject

java.util.List<BaseLine> getBaseLineListForProject(java.lang.Integer projectId)

Gets a list of active BaseLines. See getFullBaseLineListForProject(Integer) for getting inactive AND active baselines.

Parameters:

projectId - The id of a Project

Returns:

The list of all baselines associated with the Project

getFullBaseLineListForProject

java.util.List<BaseLine> getFullBaseLineListForProject(java.lang.Integer projectId)

Gets a full list of BaseLines, including active AND inactive ones. See getBaseLineListForProject(Integer) for only getting active baselines

Parameters:

projectId - The id of a Project

Returns:

The list of all baselines associated with the Project

getBaseLine

BaseLine getBaseLine(java.lang.Integer baseLineId)

saveBaseLine

void saveBaseLine(BaseLine baseLine)

deleteBaseLine

void deleteBaseLine(BaseLine baseLine)

Logically deletes a BaseLine. See physicallyDeleteBaseLine(BaseLine) to completely delete from the database.

Parameters:

baseLine - A BaseLine to mark inactive

deleteBaseLineGroup

void deleteBaseLineGroup(java.lang.Integer scopeId,
                         java.lang.Integer refId,
                         java.lang.Integer projectId)

Deletes the "Baseline Group" that all have the given scope id and ref id This function logically deletes this group and baseline from the database. See #physicallyDeleteBaseLineGroup(Integer, Integer) for a physical delete.

Parameters:

scopeId -

refId -

physicallyDeleteBaseLine

void physicallyDeleteBaseLine(BaseLine baseLine)

Physically deletes this BaseLine from the database. See deleteBaseLine(BaseLine) for a logical delete.

Parameters:

baseLine - A BaseLine to delete

getDocumentIds

java.util.List<java.lang.Integer> getDocumentIds(java.lang.Integer baselineId)

Gets ids of the documents that are assosciated with a baseline.

Parameters:

baselineId - the Id of the baseline

Returns:

getBaseListListByFilter

java.util.List<BaseLine> getBaseListListByFilter(java.lang.Integer filterId)

Gets all baselines associated with a filter

Parameters:

filterId - the id of the filter

Returns:

getNumberDocumentsChanged

int getNumberDocumentsChanged(java.lang.Integer baseLineId)

Gets the number of Documents that were versioned by this BaseLine that now have a more recent Version.

Parameters:

baseLineId - The id of a BaseLine

Returns:

The number of Document that have been updated (that is, there exists a Version with the same original document id, and a later version number)

getNumberActiveBaseLines

int getNumberActiveBaseLines(java.lang.Integer scopeId,
                             java.lang.Integer refId)

Gets the number of BaseLines with the given scope and ref id, and that are marked active.

Parameters:

scopeId - The scope id

refId - The ref id

Returns:

The number of active baselines with these ids

getSignaturesForBaseLine

java.util.List<Signature> getSignaturesForBaseLine(java.lang.Integer baselineId)

Gets the signatures associated with a BaseLine (and any signatures associated with a Revision that uses the BaseLine.

Parameters:

baselineId - The id of the baseline to get signatures for

Returns:

A list of associated signatures