DistributionTreeCriteria (Silverpeas Core 6.3 API)

java.lang.Object
- org.silverpeas.core.contribution.publication.dao.DistributionTreeCriteria

```
public class DistributionTreeCriteria
extends Object
```
Class that allows to set distribution tree criteria for publications and nodes.

Author:

silveryocha

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`DistributionTreeCriteria`	`ignoringInstanceIds(Collection<String> instanceIdsToIgnore)`	Sets manually the filtering on the status.
`static DistributionTreeCriteria`	`onInstanceId(String instanceId)`	Initializes distribution tree criteria axed on the given component instance id.
`DistributionTreeCriteria`	`withManualStatusFilter(String statusSubQuery)`	Sets manually the filtering on the status.
`DistributionTreeCriteria`	`withVisibilityCheck(boolean checkVisibility)`	Sets the visibility check.

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

- Method Detail
  - onInstanceId
```
public static DistributionTreeCriteria onInstanceId(String instanceId)
```
    Initializes distribution tree criteria axed on the given component instance id.
    
    Parameters:
    
    instanceId - identifier of the aimed component instance host.
    
    Returns:
    
    an initialized DistributionTreeCriteria instance.
  - withVisibilityCheck
```
public DistributionTreeCriteria withVisibilityCheck(boolean checkVisibility)
```
    Sets the visibility check.
    
    Parameters:
    
    checkVisibility - true to verify the visibility, false otherwise.
    
    Returns:
    
    itself.
  - withManualStatusFilter
```
public DistributionTreeCriteria withManualStatusFilter(String statusSubQuery)
```
    Sets manually the filtering on the status.
    No table aliases is used into final query, so table name MUST be used to avoid getting field confusion at SQL query execution.
    
    Parameters:
    
    statusSubQuery - a string representing the SQL status filtering part.
    
    Returns:
    
    itself.
  - ignoringInstanceIds
```
public DistributionTreeCriteria ignoringInstanceIds(Collection<String> instanceIdsToIgnore)
```
    Sets manually the filtering on the status.
    
    Parameters:
    
    instanceIdsToIgnore - a collection of component instance identifier which MUST be ignored.
    
    Returns:
    
    itself.