SimulationElementLister (Silverpeas Core 6.3 API)

java.lang.Object
- org.silverpeas.core.process.annotation.SimulationElementLister

Direct Known Subclasses:

AttachmentSimulationElementLister
```
public abstract class SimulationElementLister
extends Object
```
This interface permits the treatment callers to indicate the complete list of elements behind a primary key. Indeed, common services are not capable to find all elements behind a primary key associated to a complex structure of documents only known by the component caller itself.
User: Yohann Chastagnier Date: 25/10/13

Constructor Summary

Constructors
Constructor	Description
`SimulationElementLister()`	Constructor called with Class.newInstance
`SimulationElementLister(SimulationElementLister parentElementLister)`	Constructor called from an other element lister

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`addElement(SimulationElement<?> element)`
`protected ActionType`	`getActionType()`	Gets the type of the action aimed by the simulation
`abstract void`	`listElements(Object source, String language, ResourceReference targetPK)`	This method contains the treatment that lists all elements which have to be converted into dummy handled file.
`abstract void`	`listElements(ResourceReference sourcePK, String language)`	This method contains the treatment that lists all elements which have to be converted into dummy handled file.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SimulationElementLister
```
public SimulationElementLister()
```
    Constructor called with Class.newInstance
  - SimulationElementLister
```
public SimulationElementLister(SimulationElementLister parentElementLister)
```
    Constructor called from an other element lister
    
    Parameters:
    
    parentElementLister - an element lister parent to this one
- Method Detail
  - getActionType
```
protected ActionType getActionType()
```
    Gets the type of the action aimed by the simulation
    
    Returns:
    
    the action type
  - addElement
```
protected void addElement(SimulationElement<?> element)
```
  - listElements
```
public abstract void listElements(ResourceReference sourcePK,
                                  String language)
```
    This method contains the treatment that lists all elements which have to be converted into dummy handled file. To register an element, please use addElement(SimulationElement) ]
    
    Parameters:
    
    sourcePK - the parameter represents a primary key
  - listElements
```
public abstract void listElements(Object source,
                                  String language,
                                  ResourceReference targetPK)
```
    This method contains the treatment that lists all elements which have to be converted into dummy handled file. To register an element, please use addElement(SimulationElement) ]
    
    Parameters:
    
    source - could be anything