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

Interface ICapabilityFolder

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 ICapabilityFolder
extends com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData

The ICapabilityFolder object allows to read attribute values of a capability folder as well as accessing child items and related items. Item type constant: "gm.organisationmodule.capabilityFolder"

Method Summary

Modifier and Type	Method and Description
java.util.List<? extends ICapability>	getCapabilityChildren() Returns the capability children.
java.util.List<? extends ICapability>	getCapabilityChildren(int sortingCriterion) Returns the capability children.
java.util.List<? extends ICapability>	getCapabilityChildren(java.lang.String sortingProperty) Returns the capability children.
java.util.List<? extends ICapability>	getCapabilityChildrenWithCategory(java.lang.String categoryID) Returns the capability children that belong to the specified category.
java.util.List<? extends ICapability>	getCapabilityChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the capability children that belong to the specified category.
java.util.List<? extends ICapability>	getCapabilityChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the capability children that belong to the specified category.
java.util.List<? extends ICapability>	getCapabilityChildrenWithDefaultCategory() Returns the capability children that belong to the default category.
java.util.List<? extends ICapability>	getCapabilityChildrenWithDefaultCategory(int sortingCriterion) Returns the capability children that belong to the default category.
java.util.List<? extends ICapability>	getCapabilityChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the capability children that belong to the default category.
java.util.List<? extends ICapabilityFolder>	getCapabilityFolderChildren() Returns the capability folder children.
java.util.List<? extends ICapabilityFolder>	getCapabilityFolderChildren(int sortingCriterion) Returns the capability folder children.
java.util.List<? extends ICapabilityFolder>	getCapabilityFolderChildren(java.lang.String sortingProperty) Returns the capability folder children.
java.util.List<? extends ICapabilityFolder>	getCapabilityFolderChildrenWithCategory(java.lang.String categoryID) Returns the capability folder children that belong to the specified category.
java.util.List<? extends ICapabilityFolder>	getCapabilityFolderChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the capability folder children that belong to the specified category.
java.util.List<? extends ICapabilityFolder>	getCapabilityFolderChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the capability folder children that belong to the specified category.
java.util.List<? extends ICapabilityFolder>	getCapabilityFolderChildrenWithDefaultCategory() Returns the capability folder children that belong to the default category.
java.util.List<? extends ICapabilityFolder>	getCapabilityFolderChildrenWithDefaultCategory(int sortingCriterion) Returns the capability folder children that belong to the default category.
java.util.List<? extends ICapabilityFolder>	getCapabilityFolderChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the capability folder children that belong to the default category.
java.lang.String	getCapabilityIDPrefix() Returns the id prefix for new capability child items.
java.util.List<java.lang.String>	getDescription() Returns the description of the capability folder.
java.lang.String	getName() Returns the name of the capability folder.
ICapabilityFolder	getParentCapabilityFolder() Returns the parent capability folder.
boolean	hasCapabilityChildren() Returns whether this capability folder has children of type capability.
boolean	hasCapabilityFolderChildren() Returns whether this capability folder has children of type capability folder.
boolean	hasCapabilityFolderParent() Returns whether this capability folder has a parent of type capability 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

getEMFFile, 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, getCommitVersions, getCreationDate_MilliSecondsSince_01_01_1970, getCreationDate, getCreator, getDateOfLastModification_MilliSecondsSince_01_01_1970, getDateOfLastModification, getDisplayName, getLastModifier, getLinkForShow, getModificationCount, getProjectUniqueIdentifier, getTypeID, getTypeName, toRecord

Method Detail

getName

java.lang.String getName()

Returns the name of the capability 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 capability folder (!= null)

getDescription

java.util.List<java.lang.String> getDescription()

Returns the description of the capability 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 capability folder (!= null)

getCapabilityIDPrefix

java.lang.String getCapabilityIDPrefix()

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

hasCapabilityFolderParent

boolean hasCapabilityFolderParent()

Returns whether this capability folder has a parent of type capability folder.

Returns:

whether this capability folder has a parent of type capability folder

getParentCapabilityFolder

ICapabilityFolder getParentCapabilityFolder()

Returns the parent capability folder.

Returns:

the parent capability folder (or null if this capability folder has no parent or a parent of a different type)

hasCapabilityFolderChildren

boolean hasCapabilityFolderChildren()

Returns whether this capability folder has children of type capability folder.

Returns:

whether this capability folder has children of type capability folder

getCapabilityFolderChildren

java.util.List<? extends ICapabilityFolder> getCapabilityFolderChildren()

Returns the capability folder children.

The capability folder items are returned in their natural order.

Returns:

list of ICapabilityFolder objects (!= null)

getCapabilityFolderChildren

java.util.List<? extends ICapabilityFolder> getCapabilityFolderChildren(int sortingCriterion)

Returns the capability folder children.

Parameters:

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

Returns:

list of ICapabilityFolder objects (!= null)

getCapabilityFolderChildren

java.util.List<? extends ICapabilityFolder> getCapabilityFolderChildren(java.lang.String sortingProperty)

Returns the capability folder children.

Parameters:

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

Returns:

list of ICapabilityFolder objects (!= null)

getCapabilityFolderChildrenWithCategory

java.util.List<? extends ICapabilityFolder> getCapabilityFolderChildrenWithCategory(java.lang.String categoryID)

Returns the capability folder children that belong to the specified category.

The capability folder items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of ICapabilityFolder objects (!= null)

getCapabilityFolderChildrenWithCategory

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

Returns the capability 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 ICapabilityFolder objects (!= null)

getCapabilityFolderChildrenWithCategory

java.util.List<? extends ICapabilityFolder> getCapabilityFolderChildrenWithCategory(java.lang.String categoryID,
                                                                                    java.lang.String sortingProperty)

Returns the capability 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 ICapabilityFolder objects (!= null)

getCapabilityFolderChildrenWithDefaultCategory

java.util.List<? extends ICapabilityFolder> getCapabilityFolderChildrenWithDefaultCategory()

Returns the capability folder children that belong to the default category.

The capability folder items are returned in their natural order.

Returns:

list of ICapabilityFolder objects (!= null)

getCapabilityFolderChildrenWithDefaultCategory

java.util.List<? extends ICapabilityFolder> getCapabilityFolderChildrenWithDefaultCategory(int sortingCriterion)

Returns the capability 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 ICapabilityFolder objects (!= null)

getCapabilityFolderChildrenWithDefaultCategory

java.util.List<? extends ICapabilityFolder> getCapabilityFolderChildrenWithDefaultCategory(java.lang.String sortingProperty)

Returns the capability 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 ICapabilityFolder objects (!= null)

hasCapabilityChildren

boolean hasCapabilityChildren()

Returns whether this capability folder has children of type capability.

Returns:

whether this capability folder has children of type capability

getCapabilityChildren

java.util.List<? extends ICapability> getCapabilityChildren()

Returns the capability children.

The capability items are returned in their natural order.

Returns:

list of ICapability objects (!= null)

getCapabilityChildren

java.util.List<? extends ICapability> getCapabilityChildren(int sortingCriterion)

Returns the capability children.

Parameters:

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

Returns:

list of ICapability objects (!= null)

getCapabilityChildren

java.util.List<? extends ICapability> getCapabilityChildren(java.lang.String sortingProperty)

Returns the capability children.

Parameters:

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

Returns:

list of ICapability objects (!= null)

getCapabilityChildrenWithCategory

java.util.List<? extends ICapability> getCapabilityChildrenWithCategory(java.lang.String categoryID)

Returns the capability children that belong to the specified category.

The capability items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of ICapability objects (!= null)

getCapabilityChildrenWithCategory

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

Returns the capability 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 ICapability objects (!= null)

getCapabilityChildrenWithCategory

java.util.List<? extends ICapability> getCapabilityChildrenWithCategory(java.lang.String categoryID,
                                                                        java.lang.String sortingProperty)

Returns the capability 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 ICapability objects (!= null)

getCapabilityChildrenWithDefaultCategory

java.util.List<? extends ICapability> getCapabilityChildrenWithDefaultCategory()

Returns the capability children that belong to the default category.

The capability items are returned in their natural order.

Returns:

list of ICapability objects (!= null)

getCapabilityChildrenWithDefaultCategory

java.util.List<? extends ICapability> getCapabilityChildrenWithDefaultCategory(int sortingCriterion)

Returns the capability 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 ICapability objects (!= null)

getCapabilityChildrenWithDefaultCategory

java.util.List<? extends ICapability> getCapabilityChildrenWithDefaultCategory(java.lang.String sortingProperty)

Returns the capability 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 ICapability objects (!= null)