com.stratelia.silverpeas.pdc.control
Interface PdcUtilizationBm

All Known Implementing Classes:
PdcUtilizationBmImpl

public interface PdcUtilizationBm

Interface declaration

Author:

Method Summary
 int addUsedAxis(UsedAxis usedAxis, String treeId)
          Add an UsedAxis
 void deleteUsedAxis(Collection<String> usedAxisIds)
          Delete a collection of used axis
 void deleteUsedAxis(String usedAxisId)
          Delete an 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> getAxisHeaderUsedByInstanceId(String instanceId)
          Returns the distinct axis used by a given Job'Peas instance
 List<AxisHeader> getAxisHeaderUsedByInstanceIds(List<String> instanceIds)
           
 List<AxisHeader> getAxisHeaderUsedByInstanceIds(List<String> instanceIds, AxisFilter filter)
           
 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

getAxisHeaderUsedByInstanceId

List<AxisHeader> getAxisHeaderUsedByInstanceId(String instanceId)
                                               throws PdcException
Returns the distinct axis used by a given Job'Peas instance

Parameters:
instanceId - - the id of the Job'Peas
Returns:
a List of AxisHeader
Throws:
PdcException

getAxisHeaderUsedByInstanceIds

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

getAxisHeaderUsedByInstanceIds

List<AxisHeader> getAxisHeaderUsedByInstanceIds(List<String> instanceIds,
                                                AxisFilter filter)
                                                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
See Also:

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
See Also:

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
See Also:

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


Copyright © 2016 Silverpeas. All Rights Reserved.