com.stratelia.silverpeas.pdc.control
Interface PdcBm

All Known Implementing Classes:

PdcBmImpl

public interface PdcBm

Field Summary

static String	PRIMARY_AXIS The primary axis that made a PdC.
static String	SECONDARY_AXIS The secondary axis, often hiden or not used, that made a PdC and that provide more accurate classification information.

Method Summary

int	addPosition(int silverObjectId, ClassifyPosition position, String sComponentId)
int	addPosition(int silverObjectId, ClassifyPosition position, String sComponentId, boolean alertSubscribers)
void	addPositions(List<ClassifyPosition> positions, int objectId, String instanceId)
int	addUsedAxis(UsedAxis usedAxis) Method declaration
void	copyPositions(int fromObjectId, String fromInstanceId, int toObjectId, String toInstanceId)
int	createAxis(AxisHeader axisHeader) Method declaration
int	createDaughterValue(Value valueToInsert, String refValue, String treeId) Method declaration
String	createDaughterValueWithId(Value valueToInsert, String refValue, String treeId) Method declaration
void	deleteAxis(Connection con, String axisId) Method declaration
void	deleteGroupManager(String groupId)
void	deleteManager(String userId)
void	deletePosition(int positionId, String sComponentId)
void	deleteUsedAxis(Collection<String> usedAxisIds) Method declaration
void	deleteUsedAxis(String usedAxisId) Method declaration
String	deleteValue(Connection con, String valueId, String axisId, String treeId) Method declaration
void	deleteValueAndSubtree(Connection con, String valueId, String axisId, String treeId) Method declaration
List<Integer>	findSilverContentIdByPosition(ContainerPositionInterface containerPosition, List<String> alComponentId) Find all the SilverContentId with the given position
List<Integer>	findSilverContentIdByPosition(ContainerPositionInterface containerPosition, List<String> alComponentId, boolean recursiveSearch, boolean visibilitySensitive)
List<Integer>	findSilverContentIdByPosition(ContainerPositionInterface containerPosition, List<String> alComponentId, String authorId, String afterDate, String beforeDate)
List<Integer>	findSilverContentIdByPosition(ContainerPositionInterface containerPosition, List<String> alComponentId, String authorId, String afterDate, String beforeDate, boolean recursiveSearch, boolean visibilitySensitive) Find all the SilverContentId with the given position
List<AxisHeader>	getAxis() Method declaration
List<AxisHeader>	getAxisByType(String type)
Axis	getAxisDetail(String axisId) Method declaration
Axis	getAxisDetail(String axisId, AxisFilter filter)
AxisHeader	getAxisHeader(String axisId) Method declaration
Value	getAxisValue(String valueId, String treeId) Method declaration
List<Value>	getAxisValues(int treeId)
List<Value>	getAxisValuesByName(String valueName) Return a list of axis values having the value name in parameter
List<Value>	getDaughters(String refValue, String treeId)
List<String>	getDaughterValues(String axisId, String valueId) Return a list of String corresponding to the valueId of the value in parameter
List<Value>	getFilteredAxisValues(String rootId, AxisFilter filter) Return a list of String corresponding to the valueId of the value in parameter
List<Value>	getFirstLevelAxisValuesByInstanceId(SearchContext searchContext, String axisId, String instanceId)
List<Value>	getFirstLevelAxisValuesByInstanceIds(SearchContext searchContext, String axisId, List<String> instanceIds)
List<Value>	getFullPath(String valueId, String treeId) Method declaration
List<List<String>>	getInheritedManagers(Value value) retourne les droits hérités sur la valeur
List<List<String>>	getManagers(String axisId, String valueId) retourne les droits sur la valeur
int	getNbAxis() Method declaration
int	getNbMaxAxis()
List<SearchAxis>	getPertinentAxis(SearchContext searchContext, String axisType) Search methods
List<SearchAxis>	getPertinentAxisByInstanceId(SearchContext searchContext, String axisType, String instanceId)
List<SearchAxis>	getPertinentAxisByInstanceId(SearchContext searchContext, String axisType, String instanceId, AxisFilter filter)
List<SearchAxis>	getPertinentAxisByInstanceIds(SearchContext searchContext, String axisType, List<String> instanceIds)
List<SearchAxis>	getPertinentAxisByInstanceIds(SearchContext searchContext, String axisType, List<String> instanceIds, AxisFilter filter)
List<Value>	getPertinentDaughterValuesByInstanceId(SearchContext searchContext, String axisId, String valueId, String instanceId)
List<Value>	getPertinentDaughterValuesByInstanceId(SearchContext searchContext, String axisId, String valueId, String instanceId, AxisFilter filter)
List<Value>	getPertinentDaughterValuesByInstanceIds(SearchContext searchContext, String axisId, String valueId, List<String> instanceIds)
List<Value>	getPertinentDaughterValuesByInstanceIds(SearchContext searchContext, String axisId, String valueId, List<String> instanceIds, AxisFilter filter)
List<ClassifyPosition>	getPositions(int silverObjectId, String sComponentId)
Value	getRoot(String axisId) Return the Value corresponding to the axis done
List<Value>	getSubAxisValues(String axisId, String valueId)
String	getTreeId(String axisId)
UsedAxis	getUsedAxis(String usedAxisId) ****************************************************************
List<UsedAxis>	getUsedAxisByInstanceId(String instanceId) Method declaration
List<UsedAxis>	getUsedAxisToClassify(String instanceId, int silverObjectId) Gets the axis used by the specified component instance to classify the specified Silverpeas object.
Value	getValue(String axisId, String valueId)
void	indexAllAxis()
int	insertMotherValue(Value valueToInsert, String refValue, String axisId) Method declaration
boolean	isClassifyingMandatory(String componentId)
boolean	isUserManager(String userId)
int	moveValueToNewFatherId(Axis axis, Value valueToMove, String newFatherId, int orderNumber) Déplace une valeur et ses sous-valeurs sous un nouveau père
void	razManagers(String axisId, String valueId) supprime tous les droits sur la valeur
void	setManagers(List<String> userIds, List<String> groupIds, String axisId, String valueId) met à jour les droits sur la valeur
int	updateAxis(AxisHeader axisHeader) Method declaration
int	updatePosition(ClassifyPosition position, String instanceId, int silverObjectId)
int	updatePosition(ClassifyPosition position, String instanceId, int silverObjectId, boolean alertSubscribers)
int	updateUsedAxis(UsedAxis usedAxis) Method declaration
int	updateValue(Value value, String treeId) Method declaration

Field Detail

PRIMARY_AXIS

static final String PRIMARY_AXIS

The primary axis that made a PdC.

See Also:

Constant Field Values

SECONDARY_AXIS

static final String SECONDARY_AXIS

The secondary axis, often hiden or not used, that made a PdC and that provide more accurate classification information.

See Also:

Constant Field Values

Method Detail

getAxisByType

List<AxisHeader> getAxisByType(String type)
                               throws PdcException

Throws:

PdcException

getAxis

List<AxisHeader> getAxis()
                         throws PdcException

Method declaration

Returns:

Throws:

PdcException

See Also:

getNbAxis

int getNbAxis()
              throws PdcException

Method declaration

Returns:

Throws:

PdcException

See Also:

getNbMaxAxis

int getNbMaxAxis()
                 throws PdcException

Throws:

PdcException

createAxis

int createAxis(AxisHeader axisHeader)
               throws PdcException

Method declaration

Parameters:

axisHeader -

Returns:

Throws:

PdcException

See Also:

updateAxis

int updateAxis(AxisHeader axisHeader)
               throws PdcException

Method declaration

Parameters:

axisHeader -

Returns:

Throws:

PdcException

See Also:

deleteAxis

void deleteAxis(Connection con,
                String axisId)
                throws PdcException

Method declaration

Parameters:

axisId -

Throws:

PdcException

See Also:

getAxisDetail

Axis getAxisDetail(String axisId)
                   throws PdcException

Method declaration

Parameters:

axisId -

Returns:

Throws:

PdcException

See Also:

getAxisDetail

Axis getAxisDetail(String axisId,
                   AxisFilter filter)
                   throws PdcException

Throws:

PdcException

getAxisHeader

AxisHeader getAxisHeader(String axisId)
                         throws PdcException

Method declaration

Parameters:

axisId -

Returns:

Throws:

PdcException

See Also:

getValue

Value getValue(String axisId,
               String valueId)
               throws PdcException

Throws:

PdcException

getAxisValue

Value getAxisValue(String valueId,
                   String treeId)
                   throws PdcException

Method declaration

Parameters:

valueId -

Returns:

Throws:

PdcException

See Also:

getAxisValuesByName

List<Value> getAxisValuesByName(String valueName)
                                throws PdcException

Return a list of axis values having the value name in parameter

Parameters:

valueName -

Returns:

List

Throws:

PdcException

See Also:

getDaughterValues

List<String> getDaughterValues(String axisId,
                               String valueId)
                               throws PdcException

Return a list of String corresponding to the valueId of the value in parameter

Parameters:

axisId -

valueId -

Returns:

List

Throws:

PdcException

See Also:

getFilteredAxisValues

List<Value> getFilteredAxisValues(String rootId,
                                  AxisFilter filter)
                                  throws PdcException

Return a list of String corresponding to the valueId of the value in parameter

Parameters:

axisId -

valueId -

Returns:

List

Throws:

PdcException

See Also:

getRoot

Value getRoot(String axisId)
              throws PdcException

Return the Value corresponding to the axis done

Parameters:

axisId -

Returns:

Value

Throws:

PdcException

See Also:

getAxisValues

List<Value> getAxisValues(int treeId)
                          throws PdcException

Parameters:

treeId - The id of the selected axis.

Returns:

The list of values of the axis.

Throws:

PdcException

insertMotherValue

int insertMotherValue(Value valueToInsert,
                      String refValue,
                      String axisId)
                      throws PdcException

Method declaration

Parameters:

valueToInsert -

refValue -

axisId -

Returns:

Throws:

PdcException

See Also:

moveValueToNewFatherId

int moveValueToNewFatherId(Axis axis,
                           Value valueToMove,
                           String newFatherId,
                           int orderNumber)
                           throws PdcException

Déplace une valeur et ses sous-valeurs sous un nouveau père

Parameters:

axis -

valueToMove -

newFatherId -

Returns:

1 si valeur soeur de même nom

Throws:

PdcException

getManagers

List<List<String>> getManagers(String axisId,
                               String valueId)
                               throws PdcException

retourne les droits sur la valeur

Parameters:

current - value

Returns:

ArrayList( ArrayList UsersId, ArrayList GroupsId)

Throws:

PdcException

isUserManager

boolean isUserManager(String userId)
                      throws PdcException

Throws:

PdcException

getInheritedManagers

List<List<String>> getInheritedManagers(Value value)
                                        throws PdcException

retourne les droits hérités sur la valeur

Parameters:

current - value

Returns:

ArrayList( ArrayList UsersId, ArrayList GroupsId)

Throws:

PdcException

setManagers

void setManagers(List<String> userIds,
                 List<String> groupIds,
                 String axisId,
                 String valueId)
                 throws PdcException

met à jour les droits sur la valeur

Parameters:

ArrayList - ( ArrayList UsersId, ArrayList GroupsId), current value

Throws:

PdcException

razManagers

void razManagers(String axisId,
                 String valueId)
                 throws PdcException

supprime tous les droits sur la valeur

Parameters:

current - value

Throws:

PdcException

deleteManager

void deleteManager(String userId)
                   throws PdcException

Throws:

PdcException

deleteGroupManager

void deleteGroupManager(String groupId)
                        throws PdcException

Throws:

PdcException

createDaughterValue

int createDaughterValue(Value valueToInsert,
                        String refValue,
                        String treeId)
                        throws PdcException

Method declaration

Parameters:

valueToInsert -

refValue -

Returns:

status

Throws:

PdcException

See Also:

createDaughterValueWithId

String createDaughterValueWithId(Value valueToInsert,
                                 String refValue,
                                 String treeId)
                                 throws PdcException

Method declaration

Parameters:

valueToInsert -

refValue -

Returns:

daughterid

Throws:

PdcException

See Also:

updateValue

int updateValue(Value value,
                String treeId)
                throws PdcException

Method declaration

Parameters:

value -

Returns:

Throws:

PdcException

See Also:

deleteValueAndSubtree

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

Method declaration

Parameters:

valueId -

Throws:

PdcException

See Also:

deleteValue

String deleteValue(Connection con,
                   String valueId,
                   String axisId,
                   String treeId)
                   throws PdcException

Method declaration

Parameters:

valueId -

Throws:

PdcException

See Also:

getFullPath

List<Value> getFullPath(String valueId,
                        String treeId)
                        throws PdcException

Method declaration

Parameters:

valueId -

Returns:

Throws:

PdcException

See Also:

getTreeId

String getTreeId(String axisId)
                 throws PdcException

Throws:

PdcException

getUsedAxis

UsedAxis getUsedAxis(String usedAxisId)
                     throws PdcException

****************************************************************

Throws:

PdcException

getUsedAxisByInstanceId

List<UsedAxis> getUsedAxisByInstanceId(String instanceId)
                                       throws PdcException

Method declaration

Parameters:

instanceId -

Returns:

Throws:

PdcException

See Also:

addUsedAxis

int addUsedAxis(UsedAxis usedAxis)
                throws PdcException

Method declaration

Parameters:

usedAxis -

Returns:

Throws:

PdcException

See Also:

updateUsedAxis

int updateUsedAxis(UsedAxis usedAxis)
                   throws PdcException

Method declaration

Parameters:

usedAxis -

Returns:

Throws:

PdcException

See Also:

deleteUsedAxis

void deleteUsedAxis(String usedAxisId)
                    throws PdcException

Method declaration

Parameters:

usedAxisId -

Throws:

PdcException

See Also:

deleteUsedAxis

void deleteUsedAxis(Collection<String> usedAxisIds)
                    throws PdcException

Method declaration

Parameters:

usedAxisIds -

Throws:

PdcException

See Also:

getUsedAxisToClassify

List<UsedAxis> getUsedAxisToClassify(String instanceId,
                                     int silverObjectId)
                                     throws PdcException

Gets the axis used by the specified component instance to classify the specified Silverpeas object. If there is no axis configured to be used in the component instance, then all PdC axis are returned as axis that can be used for classifying a content. If the content is already classified, then the values on invariant axis are used as invariant values.

Parameters:

instanceId - the unique identifier of the component instance.

silverObjectId - the Silverpeas object identifier representing the content to classify.

Returns:

a list of axis to use in the classification of a content.

Throws:

PdcException - if an error occurs while getting the PdC axis for the specified component instance.

addPosition

int addPosition(int silverObjectId,
                ClassifyPosition position,
                String sComponentId)
                throws PdcException

Throws:

PdcException

addPosition

int addPosition(int silverObjectId,
                ClassifyPosition position,
                String sComponentId,
                boolean alertSubscribers)
                throws PdcException

Throws:

PdcException

updatePosition

int updatePosition(ClassifyPosition position,
                   String instanceId,
                   int silverObjectId)
                   throws PdcException

Throws:

PdcException

updatePosition

int updatePosition(ClassifyPosition position,
                   String instanceId,
                   int silverObjectId,
                   boolean alertSubscribers)
                   throws PdcException

Throws:

PdcException

deletePosition

void deletePosition(int positionId,
                    String sComponentId)
                    throws PdcException

Throws:

PdcException

addPositions

void addPositions(List<ClassifyPosition> positions,
                  int objectId,
                  String instanceId)
                  throws PdcException

Throws:

PdcException

copyPositions

void copyPositions(int fromObjectId,
                   String fromInstanceId,
                   int toObjectId,
                   String toInstanceId)
                   throws PdcException

Throws:

PdcException

getPositions

List<ClassifyPosition> getPositions(int silverObjectId,
                                    String sComponentId)
                                    throws PdcException

Throws:

PdcException

isClassifyingMandatory

boolean isClassifyingMandatory(String componentId)
                               throws PdcException

Throws:

PdcException

getPertinentAxis

List<SearchAxis> getPertinentAxis(SearchContext searchContext,
                                  String axisType)
                                  throws PdcException

Search methods

Throws:

PdcException

getPertinentAxisByInstanceId

List<SearchAxis> getPertinentAxisByInstanceId(SearchContext searchContext,
                                              String axisType,
                                              String instanceId)
                                              throws PdcException

Throws:

PdcException

getPertinentAxisByInstanceId

List<SearchAxis> getPertinentAxisByInstanceId(SearchContext searchContext,
                                              String axisType,
                                              String instanceId,
                                              AxisFilter filter)
                                              throws PdcException

Throws:

PdcException

getPertinentAxisByInstanceIds

List<SearchAxis> getPertinentAxisByInstanceIds(SearchContext searchContext,
                                               String axisType,
                                               List<String> instanceIds)
                                               throws PdcException

Throws:

PdcException

getPertinentAxisByInstanceIds

List<SearchAxis> getPertinentAxisByInstanceIds(SearchContext searchContext,
                                               String axisType,
                                               List<String> instanceIds,
                                               AxisFilter filter)
                                               throws PdcException

Throws:

PdcException

getFirstLevelAxisValuesByInstanceId

List<Value> getFirstLevelAxisValuesByInstanceId(SearchContext searchContext,
                                                String axisId,
                                                String instanceId)
                                                throws PdcException

Throws:

PdcException

getFirstLevelAxisValuesByInstanceIds

List<Value> getFirstLevelAxisValuesByInstanceIds(SearchContext searchContext,
                                                 String axisId,
                                                 List<String> instanceIds)
                                                 throws PdcException

Throws:

PdcException

getPertinentDaughterValuesByInstanceId

List<Value> getPertinentDaughterValuesByInstanceId(SearchContext searchContext,
                                                   String axisId,
                                                   String valueId,
                                                   String instanceId)
                                                   throws PdcException

Throws:

PdcException

getPertinentDaughterValuesByInstanceId

List<Value> getPertinentDaughterValuesByInstanceId(SearchContext searchContext,
                                                   String axisId,
                                                   String valueId,
                                                   String instanceId,
                                                   AxisFilter filter)
                                                   throws PdcException

Throws:

PdcException

getPertinentDaughterValuesByInstanceIds

List<Value> getPertinentDaughterValuesByInstanceIds(SearchContext searchContext,
                                                    String axisId,
                                                    String valueId,
                                                    List<String> instanceIds)
                                                    throws PdcException

Throws:

PdcException

getPertinentDaughterValuesByInstanceIds

List<Value> getPertinentDaughterValuesByInstanceIds(SearchContext searchContext,
                                                    String axisId,
                                                    String valueId,
                                                    List<String> instanceIds,
                                                    AxisFilter filter)
                                                    throws PdcException

Throws:

PdcException

findSilverContentIdByPosition

List<Integer> findSilverContentIdByPosition(ContainerPositionInterface containerPosition,
                                            List<String> alComponentId,
                                            String authorId,
                                            String afterDate,
                                            String beforeDate)
                                            throws ContainerManagerException

Throws:

ContainerManagerException

findSilverContentIdByPosition

List<Integer> findSilverContentIdByPosition(ContainerPositionInterface containerPosition,
                                            List<String> alComponentId,
                                            String authorId,
                                            String afterDate,
                                            String beforeDate,
                                            boolean recursiveSearch,
                                            boolean visibilitySensitive)
                                            throws ContainerManagerException

Find all the SilverContentId with the given position

Throws:

ContainerManagerException

findSilverContentIdByPosition

List<Integer> findSilverContentIdByPosition(ContainerPositionInterface containerPosition,
                                            List<String> alComponentId)
                                            throws ContainerManagerException

Find all the SilverContentId with the given position

Throws:

ContainerManagerException

findSilverContentIdByPosition

List<Integer> findSilverContentIdByPosition(ContainerPositionInterface containerPosition,
                                            List<String> alComponentId,
                                            boolean recursiveSearch,
                                            boolean visibilitySensitive)
                                            throws ContainerManagerException

Throws:

ContainerManagerException

getDaughters

List<Value> getDaughters(String refValue,
                         String treeId)

getSubAxisValues

List<Value> getSubAxisValues(String axisId,
                             String valueId)

indexAllAxis

void indexAllAxis()
                  throws PdcException

Throws:

PdcException