Package org.silverpeas.core.admin.service

Class SpaceWithSubSpacesAndComponents.ComponentInstanceSelector

java.lang.Object

org.silverpeas.core.admin.service.SpaceWithSubSpacesAndComponents.ComponentInstanceSelector

Enclosing class:

SpaceWithSubSpacesAndComponents

public static class SpaceWithSubSpacesAndComponents.ComponentInstanceSelector
extends Object

This class permits to select component instances from a SpaceWithSubSpacesAndComponents representing a current view according some rules.

Method Summary

Modifier and Type	Method	Description
SpaceWithSubSpacesAndComponents.ComponentInstanceSelector	excludingComponentInstances(Set<String> componentIdsToExclude)	Calling this method in order to exclude some component instances from the result.
SpaceWithSubSpacesAndComponents.ComponentInstanceSelector	fromAllSpaces()	Calling this method means that all component instances from the view have to be selected.
SpaceWithSubSpacesAndComponents.ComponentInstanceSelector	fromSpaces(Set<String> spaces)	Calling this method means that all component instances from the given spaces have to be selected.
SpaceWithSubSpacesAndComponents.ComponentInstanceSelector	fromSubSpacesOfSpaces(Set<String> spaces)	Calling this method means that all component instances from sub spaces of the given spaces have to be selected.
List<SilverpeasComponentInstance>	select()	Processes the selection.

Methods inherited from class java.lang.Object

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

Method Detail

fromAllSpaces

public SpaceWithSubSpacesAndComponents.ComponentInstanceSelector fromAllSpaces()

Calling this method means that all component instances from the view have to be selected.

Returns:

the selector itself.

fromSpaces

public SpaceWithSubSpacesAndComponents.ComponentInstanceSelector fromSpaces(Set<String> spaces)

Calling this method means that all component instances from the given spaces have to be selected.

Parameters:

spaces - set of space identifiers.

Returns:

the selector itself.

fromSubSpacesOfSpaces

public SpaceWithSubSpacesAndComponents.ComponentInstanceSelector fromSubSpacesOfSpaces(Set<String> spaces)

Calling this method means that all component instances from sub spaces of the given spaces have to be selected.

Parameters:

spaces - set of space identifiers.

Returns:

the selector itself.

excludingComponentInstances

public SpaceWithSubSpacesAndComponents.ComponentInstanceSelector excludingComponentInstances(Set<String> componentIdsToExclude)

Calling this method in order to exclude some component instances from the result.

Parameters:

componentIdsToExclude - set of component instance identifiers.

Returns:

the selector itself.

select

public List<SilverpeasComponentInstance> select()

Processes the selection.

Please parametrize the selector before calling this method.

Returns:

a list of SilverpeasComponentInstance instances.