IFolder

All Superinterfaces:

com.arcway.cockpit.docgen.provider.interfaces.ICockpitData, com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess, com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData, com.arcway.cockpit.docgen.provider.interfaces.IGraphic, com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData
```
public interface IFolder
extends com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData
```
The IFolder object allows to read attribute values of a folder as well as accessing child items and related items. Item type constant: "gm.crmdocumentationmodule.folder"

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.util.List<? extends IApplet>`	`getAppletChildren()` Returns the applet children.
`java.util.List<? extends IApplet>`	`getAppletChildren(int sortingCriterion)` Returns the applet children.
`java.util.List<? extends IApplet>`	`getAppletChildren(java.lang.String sortingProperty)` Returns the applet children.
`java.util.List<? extends IButton>`	`getButtonChildren()` Returns the button children.
`java.util.List<? extends IButton>`	`getButtonChildren(int sortingCriterion)` Returns the button children.
`java.util.List<? extends IButton>`	`getButtonChildren(java.lang.String sortingProperty)` Returns the button children.
`java.util.List<java.lang.String>`	`getDescription()` Returns the description of the folder.
`java.util.List<? extends IEAMFeature>`	`getEAMFeatureChildren()` Returns the eam feature children.
`java.util.List<? extends IEAMFeature>`	`getEAMFeatureChildren(int sortingCriterion)` Returns the eam feature children.
`java.util.List<? extends IEAMFeature>`	`getEAMFeatureChildren(java.lang.String sortingProperty)` Returns the eam feature children.
`java.util.List<? extends IField>`	`getFieldChildren()` Returns the field children.
`java.util.List<? extends IField>`	`getFieldChildren(int sortingCriterion)` Returns the field children.
`java.util.List<? extends IField>`	`getFieldChildren(java.lang.String sortingProperty)` Returns the field children.
`java.util.List<? extends IFolder>`	`getFolderChildren()` Returns the folder children.
`java.util.List<? extends IFolder>`	`getFolderChildren(int sortingCriterion)` Returns the folder children.
`java.util.List<? extends IFolder>`	`getFolderChildren(java.lang.String sortingProperty)` Returns the folder children.
`java.util.List<? extends IGlossaryTerm>`	`getGlossaryTermChildren()` Returns the glossary term children.
`java.util.List<? extends IGlossaryTerm>`	`getGlossaryTermChildren(int sortingCriterion)` Returns the glossary term children.
`java.util.List<? extends IGlossaryTerm>`	`getGlossaryTermChildren(java.lang.String sortingProperty)` Returns the glossary term children.
`java.util.List<? extends IListofValues>`	`getListofValuesChildren()` Returns the list of values children.
`java.util.List<? extends IListofValues>`	`getListofValuesChildren(int sortingCriterion)` Returns the list of values children.
`java.util.List<? extends IListofValues>`	`getListofValuesChildren(java.lang.String sortingProperty)` Returns the list of values children.
`java.lang.String`	`getName()` Returns the name of the folder.
`IFolder`	`getParentFolder()` Returns the parent folder.
`java.util.List<? extends IPredefinedQuery>`	`getPredefinedQueryChildren()` Returns the predefined query children.
`java.util.List<? extends IPredefinedQuery>`	`getPredefinedQueryChildren(int sortingCriterion)` Returns the predefined query children.
`java.util.List<? extends IPredefinedQuery>`	`getPredefinedQueryChildren(java.lang.String sortingProperty)` Returns the predefined query children.
`java.util.List<? extends IView>`	`getViewChildren()` Returns the view children.
`java.util.List<? extends IView>`	`getViewChildren(int sortingCriterion)` Returns the view children.
`java.util.List<? extends IView>`	`getViewChildren(java.lang.String sortingProperty)` Returns the view children.
`boolean`	`hasAppletChildren()` Returns whether this folder has children of type applet.
`boolean`	`hasButtonChildren()` Returns whether this folder has children of type button.
`boolean`	`hasEAMFeatureChildren()` Returns whether this folder has children of type eam feature.
`boolean`	`hasFieldChildren()` Returns whether this folder has children of type field.
`boolean`	`hasFolderChildren()` Returns whether this folder has children of type folder.
`boolean`	`hasFolderParent()` Returns whether this folder has a parent of type folder.
`boolean`	`hasGlossaryTermChildren()` Returns whether this folder has children of type glossary term.
`boolean`	`hasListofValuesChildren()` Returns whether this folder has children of type list of values.
`boolean`	`hasPredefinedQueryChildren()` Returns whether this folder has children of type predefined query.
`boolean`	`hasViewChildren()` Returns whether this folder has children of type view.

Methods inherited from interface com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData
getAncestorObjects, getAttribute_asParagraphList, getAttribute_asSingleLine, getAttribute_asTimestamp_MilliSecondsSince_01_01_1970, getAttribute, getChildObjects, getChildObjects, getChildObjectsOfTypeRank, getChildObjectsWithCategory, getChildObjectsWithCategory, getChildObjectsWithDefaultCategory, getChildObjectsWithDefaultCategory, getChildrenIDPrefix, getLinkedModelElements, getObjectType, getParentObject, getRelatedLOObjects, getRelatedLOObjects, getRelatedLOObjectsWithCategory, getRelatedLOObjectsWithCategory, getRelatedLOObjectsWithDefaultCategory, getRelatedLOObjectsWithDefaultCategory, getRelatedMDObjects, getRelatedMDObjects, getRelatedMDObjectsWithCategory, getRelatedMDObjectsWithCategory, getRelatedMDObjectsWithDefaultCategory, getRelatedMDObjectsWithDefaultCategory, getUniqueIdentifier, isLinkedToAnyModelElement, toRecord

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.IGraphic
getImage, getPNGFile, getSVGFile, getWMFFile

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, getModificationCount, getProjectUniqueIdentifier, getTypeID, getTypeName, toRecord

- Method Detail
  - getName
```
java.lang.String getName()
```
    Returns the name of the folder.
    
    The returned string is already HTML encoded so that it can be inserted into the document without any further transformations.
    
    Returns:
    
    name of the folder (!= null)
  - getDescription
```
java.util.List<java.lang.String> getDescription()
```
    Returns the description of the folder.
    
    If the text consists of multiple paragraphs (separated by carriage return) each paragraph is represented by a single element in the String list.
    
    The returned string is already HTML encoded so that it can be inserted into the document without any further transformations.
    
    Returns:
    
    description of the folder (!= null)
  - hasFolderParent
```
boolean hasFolderParent()
```
    Returns whether this folder has a parent of type folder.
    
    Returns:
    
    whether this folder has a parent of type folder
  - getParentFolder
```
IFolder getParentFolder()
```
    Returns the parent folder.
    
    Returns:
    
    the parent folder (or null if this folder has no parent or a parent of a different type)
  - hasFolderChildren
```
boolean hasFolderChildren()
```
    Returns whether this folder has children of type folder.
    
    Returns:
    
    whether this folder has children of type folder
  - getFolderChildren
```
java.util.List<? extends IFolder> getFolderChildren()
```
    Returns the folder children.
    
    The folder items are returned in their natural order.
    
    Returns:
    
    list of IFolder objects (!= null)
  - getFolderChildren
```
java.util.List<? extends IFolder> getFolderChildren(int sortingCriterion)
```
    Returns the folder children.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IFolder objects (!= null)
  - getFolderChildren
```
java.util.List<? extends IFolder> getFolderChildren(java.lang.String sortingProperty)
```
    Returns the folder children.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IFolder objects (!= null)
  - hasViewChildren
```
boolean hasViewChildren()
```
    Returns whether this folder has children of type view.
    
    Returns:
    
    whether this folder has children of type view
  - getViewChildren
```
java.util.List<? extends IView> getViewChildren()
```
    Returns the view children.
    
    The view items are returned in their natural order.
    
    Returns:
    
    list of IView objects (!= null)
  - getViewChildren
```
java.util.List<? extends IView> getViewChildren(int sortingCriterion)
```
    Returns the view children.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IView objects (!= null)
  - getViewChildren
```
java.util.List<? extends IView> getViewChildren(java.lang.String sortingProperty)
```
    Returns the view children.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IView objects (!= null)
  - hasAppletChildren
```
boolean hasAppletChildren()
```
    Returns whether this folder has children of type applet.
    
    Returns:
    
    whether this folder has children of type applet
  - getAppletChildren
```
java.util.List<? extends IApplet> getAppletChildren()
```
    Returns the applet children.
    
    The applet items are returned in their natural order.
    
    Returns:
    
    list of IApplet objects (!= null)
  - getAppletChildren
```
java.util.List<? extends IApplet> getAppletChildren(int sortingCriterion)
```
    Returns the applet children.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IApplet objects (!= null)
  - getAppletChildren
```
java.util.List<? extends IApplet> getAppletChildren(java.lang.String sortingProperty)
```
    Returns the applet children.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IApplet objects (!= null)
  - hasButtonChildren
```
boolean hasButtonChildren()
```
    Returns whether this folder has children of type button.
    
    Returns:
    
    whether this folder has children of type button
  - getButtonChildren
```
java.util.List<? extends IButton> getButtonChildren()
```
    Returns the button children.
    
    The button items are returned in their natural order.
    
    Returns:
    
    list of IButton objects (!= null)
  - getButtonChildren
```
java.util.List<? extends IButton> getButtonChildren(int sortingCriterion)
```
    Returns the button children.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IButton objects (!= null)
  - getButtonChildren
```
java.util.List<? extends IButton> getButtonChildren(java.lang.String sortingProperty)
```
    Returns the button children.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IButton objects (!= null)
  - hasFieldChildren
```
boolean hasFieldChildren()
```
    Returns whether this folder has children of type field.
    
    Returns:
    
    whether this folder has children of type field
  - getFieldChildren
```
java.util.List<? extends IField> getFieldChildren()
```
    Returns the field children.
    
    The field items are returned in their natural order.
    
    Returns:
    
    list of IField objects (!= null)
  - getFieldChildren
```
java.util.List<? extends IField> getFieldChildren(int sortingCriterion)
```
    Returns the field children.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IField objects (!= null)
  - getFieldChildren
```
java.util.List<? extends IField> getFieldChildren(java.lang.String sortingProperty)
```
    Returns the field children.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IField objects (!= null)
  - hasListofValuesChildren
```
boolean hasListofValuesChildren()
```
    Returns whether this folder has children of type list of values.
    
    Returns:
    
    whether this folder has children of type list of values
  - getListofValuesChildren
```
java.util.List<? extends IListofValues> getListofValuesChildren()
```
    Returns the list of values children.
    
    The list of values items are returned in their natural order.
    
    Returns:
    
    list of IListofValues objects (!= null)
  - getListofValuesChildren
```
java.util.List<? extends IListofValues> getListofValuesChildren(int sortingCriterion)
```
    Returns the list of values children.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IListofValues objects (!= null)
  - getListofValuesChildren
```
java.util.List<? extends IListofValues> getListofValuesChildren(java.lang.String sortingProperty)
```
    Returns the list of values children.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IListofValues objects (!= null)
  - hasPredefinedQueryChildren
```
boolean hasPredefinedQueryChildren()
```
    Returns whether this folder has children of type predefined query.
    
    Returns:
    
    whether this folder has children of type predefined query
  - getPredefinedQueryChildren
```
java.util.List<? extends IPredefinedQuery> getPredefinedQueryChildren()
```
    Returns the predefined query children.
    
    The predefined query items are returned in their natural order.
    
    Returns:
    
    list of IPredefinedQuery objects (!= null)
  - getPredefinedQueryChildren
```
java.util.List<? extends IPredefinedQuery> getPredefinedQueryChildren(int sortingCriterion)
```
    Returns the predefined query children.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IPredefinedQuery objects (!= null)
  - getPredefinedQueryChildren
```
java.util.List<? extends IPredefinedQuery> getPredefinedQueryChildren(java.lang.String sortingProperty)
```
    Returns the predefined query children.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IPredefinedQuery objects (!= null)
  - hasEAMFeatureChildren
```
boolean hasEAMFeatureChildren()
```
    Returns whether this folder has children of type eam feature.
    
    Returns:
    
    whether this folder has children of type eam feature
  - getEAMFeatureChildren
```
java.util.List<? extends IEAMFeature> getEAMFeatureChildren()
```
    Returns the eam feature children.
    
    The eam feature items are returned in their natural order.
    
    Returns:
    
    list of IEAMFeature objects (!= null)
  - getEAMFeatureChildren
```
java.util.List<? extends IEAMFeature> getEAMFeatureChildren(int sortingCriterion)
```
    Returns the eam feature children.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IEAMFeature objects (!= null)
  - getEAMFeatureChildren
```
java.util.List<? extends IEAMFeature> getEAMFeatureChildren(java.lang.String sortingProperty)
```
    Returns the eam feature children.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IEAMFeature objects (!= null)
  - hasGlossaryTermChildren
```
boolean hasGlossaryTermChildren()
```
    Returns whether this folder has children of type glossary term.
    
    Returns:
    
    whether this folder has children of type glossary term
  - getGlossaryTermChildren
```
java.util.List<? extends IGlossaryTerm> getGlossaryTermChildren()
```
    Returns the glossary term children.
    
    The glossary term items are returned in their natural order.
    
    Returns:
    
    list of IGlossaryTerm objects (!= null)
  - getGlossaryTermChildren
```
java.util.List<? extends IGlossaryTerm> getGlossaryTermChildren(int sortingCriterion)
```
    Returns the glossary term children.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IGlossaryTerm objects (!= null)
  - getGlossaryTermChildren
```
java.util.List<? extends IGlossaryTerm> getGlossaryTermChildren(java.lang.String sortingProperty)
```
    Returns the glossary term children.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IGlossaryTerm objects (!= null)

Interface IFolder

Method Summary

Methods inherited from interface com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData

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

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

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

Method Detail

getName

getDescription

hasFolderParent

getParentFolder

hasFolderChildren

getFolderChildren

getFolderChildren

getFolderChildren

hasViewChildren

getViewChildren

getViewChildren

getViewChildren

hasAppletChildren

getAppletChildren

getAppletChildren

getAppletChildren

hasButtonChildren

getButtonChildren

getButtonChildren

getButtonChildren

hasFieldChildren

getFieldChildren

getFieldChildren

getFieldChildren

hasListofValuesChildren

getListofValuesChildren

getListofValuesChildren

getListofValuesChildren

hasPredefinedQueryChildren

getPredefinedQueryChildren

getPredefinedQueryChildren

getPredefinedQueryChildren

hasEAMFeatureChildren

getEAMFeatureChildren

getEAMFeatureChildren

getEAMFeatureChildren

hasGlossaryTermChildren

getGlossaryTermChildren

getGlossaryTermChildren

getGlossaryTermChildren