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

Interface IResourceFolder

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

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

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getDescription() Returns the description of the resource folder.
java.lang.String	getName() Returns the name of the resource folder.
IResourceFolder	getParentResourceFolder() Returns the parent resource folder.
java.util.List<? extends IResource>	getResourceChildren() Returns the resource children.
java.util.List<? extends IResource>	getResourceChildren(int sortingCriterion) Returns the resource children.
java.util.List<? extends IResource>	getResourceChildren(java.lang.String sortingProperty) Returns the resource children.
java.util.List<? extends IResource>	getResourceChildrenWithCategory(java.lang.String categoryID) Returns the resource children that belong to the specified category.
java.util.List<? extends IResource>	getResourceChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the resource children that belong to the specified category.
java.util.List<? extends IResource>	getResourceChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the resource children that belong to the specified category.
java.util.List<? extends IResource>	getResourceChildrenWithDefaultCategory() Returns the resource children that belong to the default category.
java.util.List<? extends IResource>	getResourceChildrenWithDefaultCategory(int sortingCriterion) Returns the resource children that belong to the default category.
java.util.List<? extends IResource>	getResourceChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the resource children that belong to the default category.
java.util.List<? extends IResourceFolder>	getResourceFolderChildren() Returns the resource folder children.
java.util.List<? extends IResourceFolder>	getResourceFolderChildren(int sortingCriterion) Returns the resource folder children.
java.util.List<? extends IResourceFolder>	getResourceFolderChildren(java.lang.String sortingProperty) Returns the resource folder children.
java.util.List<? extends IResourceFolder>	getResourceFolderChildrenWithCategory(java.lang.String categoryID) Returns the resource folder children that belong to the specified category.
java.util.List<? extends IResourceFolder>	getResourceFolderChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the resource folder children that belong to the specified category.
java.util.List<? extends IResourceFolder>	getResourceFolderChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the resource folder children that belong to the specified category.
java.util.List<? extends IResourceFolder>	getResourceFolderChildrenWithDefaultCategory() Returns the resource folder children that belong to the default category.
java.util.List<? extends IResourceFolder>	getResourceFolderChildrenWithDefaultCategory(int sortingCriterion) Returns the resource folder children that belong to the default category.
java.util.List<? extends IResourceFolder>	getResourceFolderChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the resource folder children that belong to the default category.
java.lang.String	getResourceIDPrefix() Returns the id prefix for new resource child items.
boolean	hasResourceChildren() Returns whether this resource folder has children of type resource.
boolean	hasResourceFolderChildren() Returns whether this resource folder has children of type resource folder.
boolean	hasResourceFolderParent() Returns whether this resource folder has a parent of type resource 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 resource 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 resource folder (!= null)

getDescription

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

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

getResourceIDPrefix

java.lang.String getResourceIDPrefix()

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

hasResourceFolderParent

boolean hasResourceFolderParent()

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

Returns:

whether this resource folder has a parent of type resource folder

getParentResourceFolder

IResourceFolder getParentResourceFolder()

Returns the parent resource folder.

Returns:

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

hasResourceFolderChildren

boolean hasResourceFolderChildren()

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

Returns:

whether this resource folder has children of type resource folder

getResourceFolderChildren

java.util.List<? extends IResourceFolder> getResourceFolderChildren()

Returns the resource folder children.

The resource folder items are returned in their natural order.

Returns:

list of IResourceFolder objects (!= null)

getResourceFolderChildren

java.util.List<? extends IResourceFolder> getResourceFolderChildren(int sortingCriterion)

Returns the resource folder children.

Parameters:

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

Returns:

list of IResourceFolder objects (!= null)

getResourceFolderChildren

java.util.List<? extends IResourceFolder> getResourceFolderChildren(java.lang.String sortingProperty)

Returns the resource folder children.

Parameters:

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

Returns:

list of IResourceFolder objects (!= null)

getResourceFolderChildrenWithCategory

java.util.List<? extends IResourceFolder> getResourceFolderChildrenWithCategory(java.lang.String categoryID)

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

The resource folder items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of IResourceFolder objects (!= null)

getResourceFolderChildrenWithCategory

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

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

getResourceFolderChildrenWithCategory

java.util.List<? extends IResourceFolder> getResourceFolderChildrenWithCategory(java.lang.String categoryID,
                                                                                java.lang.String sortingProperty)

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

getResourceFolderChildrenWithDefaultCategory

java.util.List<? extends IResourceFolder> getResourceFolderChildrenWithDefaultCategory()

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

The resource folder items are returned in their natural order.

Returns:

list of IResourceFolder objects (!= null)

getResourceFolderChildrenWithDefaultCategory

java.util.List<? extends IResourceFolder> getResourceFolderChildrenWithDefaultCategory(int sortingCriterion)

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

getResourceFolderChildrenWithDefaultCategory

java.util.List<? extends IResourceFolder> getResourceFolderChildrenWithDefaultCategory(java.lang.String sortingProperty)

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

hasResourceChildren

boolean hasResourceChildren()

Returns whether this resource folder has children of type resource.

Returns:

whether this resource folder has children of type resource

getResourceChildren

java.util.List<? extends IResource> getResourceChildren()

Returns the resource children.

The resource items are returned in their natural order.

Returns:

list of IResource objects (!= null)

getResourceChildren

java.util.List<? extends IResource> getResourceChildren(int sortingCriterion)

Returns the resource children.

Parameters:

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

Returns:

list of IResource objects (!= null)

getResourceChildren

java.util.List<? extends IResource> getResourceChildren(java.lang.String sortingProperty)

Returns the resource children.

Parameters:

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

Returns:

list of IResource objects (!= null)

getResourceChildrenWithCategory

java.util.List<? extends IResource> getResourceChildrenWithCategory(java.lang.String categoryID)

Returns the resource children that belong to the specified category.

The resource items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of IResource objects (!= null)

getResourceChildrenWithCategory

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

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

getResourceChildrenWithCategory

java.util.List<? extends IResource> getResourceChildrenWithCategory(java.lang.String categoryID,
                                                                    java.lang.String sortingProperty)

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

getResourceChildrenWithDefaultCategory

java.util.List<? extends IResource> getResourceChildrenWithDefaultCategory()

Returns the resource children that belong to the default category.

The resource items are returned in their natural order.

Returns:

list of IResource objects (!= null)

getResourceChildrenWithDefaultCategory

java.util.List<? extends IResource> getResourceChildrenWithDefaultCategory(int sortingCriterion)

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

getResourceChildrenWithDefaultCategory

java.util.List<? extends IResource> getResourceChildrenWithDefaultCategory(java.lang.String sortingProperty)

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