com.arcway.cockpit.genericmodule.documentcontentmodule.docgen.provider.interfaces

Interface 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.documentcontentmodule.folder"

Method Summary

Modifier and Type	Method and Description
java.util.List<? extends IContainer>	getContainerChildren() Returns the container children.
java.util.List<? extends IContainer>	getContainerChildren(int sortingCriterion) Returns the container children.
java.util.List<? extends IContainer>	getContainerChildren(java.lang.String sortingProperty) Returns the container children.
java.util.List<? extends IContainer>	getContainerChildrenWithCategory(java.lang.String categoryID) Returns the container children that belong to the specified category.
java.util.List<? extends IContainer>	getContainerChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the container children that belong to the specified category.
java.util.List<? extends IContainer>	getContainerChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the container children that belong to the specified category.
java.util.List<? extends IContainer>	getContainerChildrenWithDefaultCategory() Returns the container children that belong to the default category.
java.util.List<? extends IContainer>	getContainerChildrenWithDefaultCategory(int sortingCriterion) Returns the container children that belong to the default category.
java.util.List<? extends IContainer>	getContainerChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the container children that belong to the default category.
java.util.List<java.lang.String>	getDescription() Returns the description of the folder.
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 IFolder>	getFolderChildrenWithCategory(java.lang.String categoryID) Returns the folder children that belong to the specified category.
java.util.List<? extends IFolder>	getFolderChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the folder children that belong to the specified category.
java.util.List<? extends IFolder>	getFolderChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the folder children that belong to the specified category.
java.util.List<? extends IFolder>	getFolderChildrenWithDefaultCategory() Returns the folder children that belong to the default category.
java.util.List<? extends IFolder>	getFolderChildrenWithDefaultCategory(int sortingCriterion) Returns the folder children that belong to the default category.
java.util.List<? extends IFolder>	getFolderChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the folder children that belong to the default category.
java.lang.String	getName() Returns the name of the folder.
IFolder	getParentFolder() Returns the parent folder.
java.lang.String	getPictureIDPrefix() Returns the id prefix for new picture child items.
java.lang.String	getTextIDPrefix() Returns the id prefix for new text child items.
boolean	hasContainerChildren() Returns whether this folder has children of type container.
boolean	hasFolderChildren() Returns whether this folder has children of type folder.
boolean	hasFolderParent() Returns whether this folder has a parent of type folder.

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)

getTextIDPrefix

java.lang.String getTextIDPrefix()

Returns the id prefix for new text child items.

The returned string is already HTML encoded so that it can be inserted into the document without any further transformations.

Returns:

the id prefix for new text child items (!= null)

getPictureIDPrefix

java.lang.String getPictureIDPrefix()

Returns the id prefix for new picture child items.

The returned string is already HTML encoded so that it can be inserted into the document without any further transformations.

Returns:

the id prefix for new picture child items (!= 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)

getFolderChildrenWithCategory

java.util.List<? extends IFolder> getFolderChildrenWithCategory(java.lang.String categoryID)

Returns the folder children that belong to the specified category.

The folder items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of IFolder objects (!= null)

getFolderChildrenWithCategory

java.util.List<? extends IFolder> getFolderChildrenWithCategory(java.lang.String categoryID,
                                                                int sortingCriterion)

Returns the folder children that belong to the specified category.

Parameters:

categoryID - the category ID

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IFolder objects (!= null)

getFolderChildrenWithCategory

java.util.List<? extends IFolder> getFolderChildrenWithCategory(java.lang.String categoryID,
                                                                java.lang.String sortingProperty)

Returns the folder children that belong to the specified category.

Parameters:

categoryID - the category ID

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IFolder objects (!= null)

getFolderChildrenWithDefaultCategory

java.util.List<? extends IFolder> getFolderChildrenWithDefaultCategory()

Returns the folder children that belong to the default category.

The folder items are returned in their natural order.

Returns:

list of IFolder objects (!= null)

getFolderChildrenWithDefaultCategory

java.util.List<? extends IFolder> getFolderChildrenWithDefaultCategory(int sortingCriterion)

Returns the folder children that belong to the default category.

Parameters:

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IFolder objects (!= null)

getFolderChildrenWithDefaultCategory

java.util.List<? extends IFolder> getFolderChildrenWithDefaultCategory(java.lang.String sortingProperty)

Returns the folder children that belong to the default category.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IFolder objects (!= null)

hasContainerChildren

boolean hasContainerChildren()

Returns whether this folder has children of type container.

Returns:

whether this folder has children of type container

getContainerChildren

java.util.List<? extends IContainer> getContainerChildren()

Returns the container children.

The container items are returned in their natural order.

Returns:

list of IContainer objects (!= null)

getContainerChildren

java.util.List<? extends IContainer> getContainerChildren(int sortingCriterion)

Returns the container children.

Parameters:

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IContainer objects (!= null)

getContainerChildren

java.util.List<? extends IContainer> getContainerChildren(java.lang.String sortingProperty)

Returns the container children.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IContainer objects (!= null)

getContainerChildrenWithCategory

java.util.List<? extends IContainer> getContainerChildrenWithCategory(java.lang.String categoryID)

Returns the container children that belong to the specified category.

The container items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of IContainer objects (!= null)

getContainerChildrenWithCategory

java.util.List<? extends IContainer> getContainerChildrenWithCategory(java.lang.String categoryID,
                                                                      int sortingCriterion)

Returns the container children that belong to the specified category.

Parameters:

categoryID - the category ID

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IContainer objects (!= null)

getContainerChildrenWithCategory

java.util.List<? extends IContainer> getContainerChildrenWithCategory(java.lang.String categoryID,
                                                                      java.lang.String sortingProperty)

Returns the container children that belong to the specified category.

Parameters:

categoryID - the category ID

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IContainer objects (!= null)

getContainerChildrenWithDefaultCategory

java.util.List<? extends IContainer> getContainerChildrenWithDefaultCategory()

Returns the container children that belong to the default category.

The container items are returned in their natural order.

Returns:

list of IContainer objects (!= null)

getContainerChildrenWithDefaultCategory

java.util.List<? extends IContainer> getContainerChildrenWithDefaultCategory(int sortingCriterion)

Returns the container children that belong to the default category.

Parameters:

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IContainer objects (!= null)

getContainerChildrenWithDefaultCategory

java.util.List<? extends IContainer> getContainerChildrenWithDefaultCategory(java.lang.String sortingProperty)

Returns the container children that belong to the default category.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IContainer objects (!= null)