Folder (Silverpeas Core 6.3 API)

All Superinterfaces:

Contribution, Instance<Contribution>, Nameable, Securable, Serializable, SilverpeasResource

All Known Implementing Classes:

NodeDetail
```
public interface Folder
extends Contribution
```
A folder is a contribution with folding capabilities that can contain others contributions, folders included. The folder is dedicated to be used to categorize others contributions, with each sub-folders being a refinement of the categorization.
The links between each folders in a given application shape a tree of folders in which the leaves are the non-folder contributions. Such a tree must be rooted to a single folder, a virtual one, representing in fact the application itself as a container of its contributions.

Author:

mmoquillon

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`isBin()`	Is this folder a dedicated one for removed contributions?
`boolean`	`isChild()`	Is this folder a child of another folder?
`boolean`	`isRoot()`	Is this folder the root one?
`boolean`	`isUnclassified()`	Is this folder a dedicated one for unclassified, uncategorized contributions?

Methods inherited from interface org.silverpeas.core.contribution.model.Contribution
canBeAccessedBy, getContributionType, getDescription, getIdentifier, getModel, getName, getResourcePath, getTitle, isIndexable

Methods inherited from interface org.silverpeas.core.Instance
getParent

Methods inherited from interface org.silverpeas.core.security.Securable
canBeDeletedBy, canBeFiledInBy, canBeModifiedBy

Methods inherited from interface org.silverpeas.core.SilverpeasResource
getCreationDate, getCreator, getLastUpdateDate, getLastUpdater

- Method Detail
  - isRoot
```
boolean isRoot()
```
    Is this folder the root one? A root folder represents the application itself as the container of its contributions.
    
    Returns:
    
    true if this folder is a root one. False otherwise.
  - isChild
```
boolean isChild()
```
    Is this folder a child of another folder? If no, then the folder is either an orphan one or a root.
    
    Returns:
    
    true if this folder is a child of another one. False otherwise.
  - isUnclassified
```
boolean isUnclassified()
```
    Is this folder a dedicated one for unclassified, uncategorized contributions?
    
    Returns:
    
    true if this folder is for gathers all the uncategorized contributions. False otherwise.
  - isBin
```
boolean isBin()
```
    Is this folder a dedicated one for removed contributions? In some applications supporting the categorization of contributions with folders, the deletion of contributions is just a moving of them into a special folder acting then like a bin of removed contributions.
    
    Returns:
    
    true if this folder is a bin of removed contributions. False otherwise.