IFolder

All Superinterfaces:

ICockpitData, ICustomPropertiesAccess
```
public interface IFolder
extends ICustomPropertiesAccess
```
IFolder allows to read attribute values of a folder within a project and to access the plans within the folder.
Item type constant: "folder"

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`containsPlans()` Checks whether the current folder contains any plans.
`java.util.List<? extends IPlan>`	`getAllPlansOfSubTree()` Returns all plans of the folder and all sub folders.
`java.util.List<? extends IPlan>`	`getAllPlansOfSubTreeWithCategory(java.lang.String categoryID)` Returns all plans of the folder and all sub folders that belong to the specified category.
`java.util.List<? extends IPlan>`	`getAllPlansOfSubTreeWithDefaultCategory()` Returns all plans of the folder and all sub folders that belong to the default category.
`java.util.List<java.lang.String>`	`getDescription()` Returns the description of the folder.
`java.lang.String`	`getName()` Returns the name of the folder.
`IFolder`	`getParent()` Returns the parent folder of the current folder.
`java.util.List<? extends IPlan>`	`getPlans()` Returns the plans of this folder.
`java.util.List<? extends IPlan>`	`getPlansSortedBy(java.lang.String propertyID)` Returns all plans sorted by the specified property.
`java.util.List<? extends IPlan>`	`getPlansWithCategory(java.lang.String categoryID)` Returns the plans of this folder that belong to the specified category.
`java.util.List<? extends IPlan>`	`getPlansWithCategorySortedBy(java.lang.String categoryID, java.lang.String propertyID)` Returns all plans that belong to the specified category sorted by the specified property.
`java.util.List<? extends IPlan>`	`getPlansWithDefaultCategory()` Returns the plans of this folder that belong to the default category.
`java.util.List<? extends IPlan>`	`getPlansWithDefaultCategorySortedBy(java.lang.String propertyID)` Returns all plans that belong to the default category sorted by the specified property.
`IFolder`	`getSubFolder(java.lang.String folderName)` Returns the sub folder with the specified name.
`java.util.List<? extends IFolder>`	`getSubFolders()` Returns the sub folders of this folder.
`java.util.List<? extends IFolder>`	`getSubFolders(java.lang.String sortingProperty)` Returns the sub folders of this folder.
`java.util.List<? extends IFolder>`	`getSubFoldersWithCategory(java.lang.String categoryID)` Returns the sub folders of the this folder that belong to the specified category.
`java.util.List<? extends IFolder>`	`getSubFoldersWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)` Returns the sub folders of the this folder that belong to the specified category.
`java.util.List<IFolder>`	`getSubFoldersWithDefaultCategory()` Returns the sub folders of the this folder that belong to the default category.
`java.util.List<IFolder>`	`getSubFoldersWithDefaultCategory(java.lang.String sortingProperty)` Returns the sub folders of the this folder that belong to the default category.
`java.lang.String`	`getUniqueIdentifier()` Returns a unique identifier that uniquely identifies this object within the COCKPIT project.
`boolean`	`hasParent()` Checks whether the current folder has a parent folder.
`boolean`	`hasSubFolder(java.lang.String folderName)` Checks whether the current folder has a sub folder with the specified name.
`boolean`	`hasSubFolders()` Checks whether the current folder has any sub folders.
`IRecord`	`toRecord()` Converts this generic module data into a record.

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess
getCategoryID, getCategoryLabel, getDateTimeProperty_MilliSecondsSince_01_01_1970, getFileProperty, getFileProperty, getFilePropertyAsBase64StringList, getFilePropertyAsFileName, getFilePropertyAsFileName, getFilePropertyAsRawStringList, getFilePropertyAsStringList, getPropertyAsString, getPropertyAsStringArray, getPropertyAsStringList, hasCustomPropertyValues, hasDefaultCategory, hasPropertyValue, readImageInfoOfFileProperty

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData
getCommitVersion, getCreationDate_MilliSecondsSince_01_01_1970, getCreationDate, getCreator, getDateOfLastModification_MilliSecondsSince_01_01_1970, getDateOfLastModification, getDisplayName, getLastModifier, getLinkForShow, getModificationCount, getProjectUniqueIdentifier, getTypeID, getTypeName, toRecord

- Method Detail
  - getUniqueIdentifier
```
java.lang.String getUniqueIdentifier()
```
    Returns a unique identifier that uniquely identifies this object within the COCKPIT project.
    
    Example from report template:
    
    #set($folder_uid = ${folder.UniqueIdentifier})
    
    Specified by:
    
    getUniqueIdentifier in interface ICockpitData
    
    Returns:
    
    unique identifier
  - getName
```
java.lang.String getName()
```
    Returns the name of the folder.
    
    The name is already HTML encoded so that it can be inserted into the document without further tranformations.
    
    Example from report template:
    
    Folder name: ${folder.Name}
    
    Returns:
    
    name of the folder (!= null)
  - getDescription
```
java.util.List<java.lang.String> getDescription()
```
    Returns the description of the folder. If the description consists of multiple lines (ENTER), each line is represented by an element in the String array.
    
    The description text is already HTML encoded so that it can be inserted into the document without further tranformations.
    
    Example from report template:
    
    #foreach( $text in ${folder.Description}) <para>$text</para> #end
    
    Returns:
    
    Description text of the folder, splitted into multiple strings, one for each line. (!= null)
  - hasParent
```
boolean hasParent()
```
    Checks whether the current folder has a parent folder. If a folder doesn't have a parent, it's a top level folder.
    
    Returns:
    
    yes or no
  - getParent
```
IFolder getParent()
```
    Returns the parent folder of the current folder. If the current folder is a top level folder, this method returns NULL.
    
    Returns:
    
    the parent set as IFolder object or NULL if this is the top level folder
  - hasSubFolders
```
boolean hasSubFolders()
```
    Checks whether the current folder has any sub folders.
    
    Returns:
    
    true: the folder has sub folders.
  - getSubFolders
```
java.util.List<? extends IFolder> getSubFolders()
```
    Returns the sub folders of this folder.
    
    Returns:
    
    the sub folders of the current folder.
  - getSubFolders
```
java.util.List<? extends IFolder> getSubFolders(java.lang.String sortingProperty)
```
    Returns the sub folders of this folder. The sub folders are sorted according to the sortingProperty.
    
    Parameters:
    
    sortingProperty -
    
    Returns:
    
    the sub folders of the current folder.
  - getSubFoldersWithCategory
```
java.util.List<? extends IFolder> getSubFoldersWithCategory(java.lang.String categoryID)
```
    Returns the sub folders of the this folder that belong to the specified category.
    
    Parameters:
    
    categoryID - category ID
    
    Returns:
    
    the sub folders of the current folder that belong to the specified category.
  - getSubFoldersWithCategory
```
java.util.List<? extends IFolder> getSubFoldersWithCategory(java.lang.String categoryID,
                                                            java.lang.String sortingProperty)
```
    Returns the sub folders of the this folder that belong to the specified category. The sub folders are sorted according to the sortingProperty.
    
    Parameters:
    
    categoryID - the category ID
    
    sortingProperty -
    
    Returns:
    
    the sub folders of the current folder.
  - getSubFoldersWithDefaultCategory
```
java.util.List<IFolder> getSubFoldersWithDefaultCategory()
```
    Returns the sub folders of the this folder that belong to the default category.
    
    Returns:
    
    the sub folders of the current folder that belong to the default category.
  - getSubFoldersWithDefaultCategory
```
java.util.List<IFolder> getSubFoldersWithDefaultCategory(java.lang.String sortingProperty)
```
    Returns the sub folders of the this folder that belong to the default category. The sub folders are sorted according to the sortingProperty.
    
    Parameters:
    
    sortingProperty -
    
    Returns:
    
    the sub folders of the current folder.
  - hasSubFolder
```
boolean hasSubFolder(java.lang.String folderName)
```
    Checks whether the current folder has a sub folder with the specified name.
    
    Parameters:
    
    folderName - name of the requested sub folder
    
    Returns:
    
    true: the folder has a sub folder with the specified name.
  - getSubFolder
```
IFolder getSubFolder(java.lang.String folderName)
```
    Returns the sub folder with the specified name. If the current folder has no sub folder with this name, null will be returned.
    
    Parameters:
    
    folderName - name of the requested sub folder
    
    Returns:
    
    the sub folder with the specified name or null
  - containsPlans
```
boolean containsPlans()
```
    Checks whether the current folder contains any plans.
    
    Returns:
    
    true: the folder contains plans.
  - getPlans
```
java.util.List<? extends IPlan> getPlans()
```
    Returns the plans of this folder.
    
    Returns:
    
    plans of this folder
  - getAllPlansOfSubTree
```
java.util.List<? extends IPlan> getAllPlansOfSubTree()
```
    Returns all plans of the folder and all sub folders.
    
    Returns:
    
    array of plans
  - getPlansSortedBy
```
java.util.List<? extends IPlan> getPlansSortedBy(java.lang.String propertyID)
```
    Returns all plans sorted by the specified property. The property may be a custom property or one of the following standard propertries:
    - name
    - description
    - creator
    - creationDate
    - lastEditor
    - lastEditDate
    Parameters:
    
    propertyID - ID of the property the plans shall be sorted by
    
    Returns:
    
    sorted array of plans of this folder
  - getPlansWithCategory
```
java.util.List<? extends IPlan> getPlansWithCategory(java.lang.String categoryID)
```
    Returns the plans of this folder that belong to the specified category.
    
    Parameters:
    
    categoryID - the category ID
    
    Returns:
    
    plans of this folder that belong to the specified category
  - getAllPlansOfSubTreeWithCategory
```
java.util.List<? extends IPlan> getAllPlansOfSubTreeWithCategory(java.lang.String categoryID)
```
    Returns all plans of the folder and all sub folders that belong to the specified category.
    
    Parameters:
    
    categoryID - the category ID
    
    Returns:
    
    array of plans that belong to the specified category
  - getPlansWithCategorySortedBy
```
java.util.List<? extends IPlan> getPlansWithCategorySortedBy(java.lang.String categoryID,
                                                             java.lang.String propertyID)
```
    Returns all plans that belong to the specified category sorted by the specified property. The property may be a custom property or one of the following standard propertries:
    - name
    - description
    - creator
    - creationDate
    - lastEditor
    - lastEditDate
    Parameters:
    
    categoryID - the category ID
    
    propertyID - ID of the property the plans shall be sorted by
    
    Returns:
    
    sorted array of plans of this folder that belong to the specified category
  - getPlansWithDefaultCategory
```
java.util.List<? extends IPlan> getPlansWithDefaultCategory()
```
    Returns the plans of this folder that belong to the default category.
    
    Returns:
    
    plans of this folder that belong to the default category
  - getAllPlansOfSubTreeWithDefaultCategory
```
java.util.List<? extends IPlan> getAllPlansOfSubTreeWithDefaultCategory()
```
    Returns all plans of the folder and all sub folders that belong to the default category.
    
    Returns:
    
    array of plans that belong to the default category
  - getPlansWithDefaultCategorySortedBy
```
java.util.List<? extends IPlan> getPlansWithDefaultCategorySortedBy(java.lang.String propertyID)
```
    Returns all plans that belong to the default category sorted by the specified property. The property may be a custom property or one of the following standard propertries:
    - name
    - description
    - creator
    - creationDate
    - lastEditor
    - lastEditDate
    Parameters:
    
    propertyID - ID of the property the plans shall be sorted by
    
    Returns:
    
    sorted array of plans of this folder that belong to the default category
  - toRecord
```
IRecord toRecord()
```
    Converts this generic module data into a record.
    In addition to all fields documented at ICustomPropertiesAccess.toRecord(), in the created record, the following fields are filled accoring to the wrapped cockpit data:
    - IRecord.NAME_KEY
    - IRecord.DESCRIPTION_KEY
    Specified by:
    
    toRecord in interface ICockpitData
    
    Specified by:
    
    toRecord in interface ICustomPropertiesAccess
    
    Returns:
    
    converted cockpit project data

Interface IFolder

Method Summary

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData

Method Detail

getUniqueIdentifier

getName

getDescription

hasParent

getParent

hasSubFolders

getSubFolders

getSubFolders

getSubFoldersWithCategory

getSubFoldersWithCategory

getSubFoldersWithDefaultCategory

getSubFoldersWithDefaultCategory

hasSubFolder

getSubFolder

containsPlans

getPlans

getAllPlansOfSubTree

getPlansSortedBy

getPlansWithCategory

getAllPlansOfSubTreeWithCategory

getPlansWithCategorySortedBy

getPlansWithDefaultCategory

getAllPlansOfSubTreeWithDefaultCategory

getPlansWithDefaultCategorySortedBy

toRecord