Package org.silverpeas.core.pdc.pdc.service

Interface PdcUtilizationService

All Known Implementing Classes:

DefaultPdcUtilizationService

public interface PdcUtilizationService

A service in the PdC engine to filter the PdC's axis per application instance. It defines a constraining view onto the PdC for a given application instance so that each classification of the contributions in the application is done onto this view of the PdC.

Method Summary

Modifier and Type	Method	Description
int	addUsedAxis(UsedAxis usedAxis, String treeId)	Add an UsedAxis
void	deleteUsedAxis(String usedAxisId)	Delete an used axis
void	deleteUsedAxis(Collection<String> usedAxisIds)	Delete a collection of used axis
void	deleteUsedAxisByAxisId(Connection con, String axisId)	Delete used axis based on a particular axis
void	deleteUsedAxisByMotherValue(Connection con, String valueId, String axisId, String treeId)
List<AxisHeader>	getAxisHeaderUsedByInstanceIds(List<String> instanceIds)
UsedAxis	getUsedAxis(String usedAxisId)	Returns data of an used axis defined by usedAxisId
List<UsedAxis>	getUsedAxisByInstanceId(String instanceId)	Returns all the axis used by a given Job'Peas instance
void	updateOrDeleteBaseValue(Connection con, int baseValueToUpdate, int newBaseValue, int axisId, String treeId)
int	updateUsedAxis(UsedAxis usedAxis, String treeId)	Update an UsedAxis

Method Detail

getUsedAxis

UsedAxis getUsedAxis(String usedAxisId)
              throws PdcException

Returns data of an used axis defined by usedAxisId

Parameters:

usedAxisId - - id of the usedAxis

Returns:

an UsedAxis

Throws:

PdcException

getUsedAxisByInstanceId

List<UsedAxis> getUsedAxisByInstanceId(String instanceId)
                                throws PdcException

Returns all the axis used by a given Job'Peas instance

Parameters:

instanceId - - the id of the Job'Peas

Returns:

a List of UsedAxis

Throws:

PdcException

getAxisHeaderUsedByInstanceIds

List<AxisHeader> getAxisHeaderUsedByInstanceIds(List<String> instanceIds)
                                         throws PdcException

Throws:

PdcException

addUsedAxis

int addUsedAxis(UsedAxis usedAxis,
                String treeId)
         throws PdcException

Add an UsedAxis

Parameters:

usedAxis - - the UsedAxis to add

treeId -

Returns:

- 0 si, pour une même instance de Job'Peas, il n'existe pas déjà un axe avec comme valeur de base un ascendant ou un descendant - 1 sinon

Throws:

PdcException

updateUsedAxis

int updateUsedAxis(UsedAxis usedAxis,
                   String treeId)
            throws PdcException

Update an UsedAxis

Parameters:

usedAxis - - the UsedAxis to update

treeId -

Returns:

- 0 si, pour une même instance de Job'Peas, il n'existe pas déjà un axe avec comme valeur de base un ascendant ou un descendant - 1 sinon

Throws:

PdcException

deleteUsedAxis

void deleteUsedAxis(String usedAxisId)
             throws PdcException

Delete an used axis

Parameters:

usedAxisId - - the id of the used axis to delete

Throws:

PdcException

deleteUsedAxis

void deleteUsedAxis(Collection<String> usedAxisIds)
             throws PdcException

Delete a collection of used axis

Parameters:

usedAxisIds - - the ids of the used axis to delete

Throws:

PdcException

deleteUsedAxisByAxisId

void deleteUsedAxisByAxisId(Connection con,
                            String axisId)
                     throws PdcException

Delete used axis based on a particular axis

Parameters:

con -

axisId - - the axis id

Throws:

PdcException

deleteUsedAxisByMotherValue

void deleteUsedAxisByMotherValue(Connection con,
                                 String valueId,
                                 String axisId,
                                 String treeId)
                          throws PdcException

Throws:

PdcException

updateOrDeleteBaseValue

void updateOrDeleteBaseValue(Connection con,
                             int baseValueToUpdate,
                             int newBaseValue,
                             int axisId,
                             String treeId)
                      throws PdcException

Throws:

PdcException