atg.repository.content

Interface FolderItem

All Superinterfaces:

DisplayableItem

All Known Subinterfaces:

ContentRepositoryFolder, ContentRepositoryItem

All Known Implementing Classes:

GenericSecuredMutableContentItem, GenericSecuredMutableFolderItem

public interface FolderItem
extends DisplayableItem

Describes items which can be contained by folders

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	getAncestorFolderIds() Returns an array of ids for all folders which are parents of this item.
java.lang.String[]	getAncestorFolderPaths() Returns an array of paths for all folders which are parents of this item.
java.lang.String	getItemPath() Return the path of this item, represented as a "relative path" from a "document root."

Methods inherited from interface atg.repository.DisplayableItem

getItemDisplayName

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

Method Detail

getItemPath

java.lang.String getItemPath()

Return the path of this item, represented as a "relative path" from a "document root."

getAncestorFolderPaths

java.lang.String[] getAncestorFolderPaths()

Returns an array of paths for all folders which are parents of this item. If the item is the root folder then return an empty array. For example: if you have a piece of content with the itemPath property value "/foo/bar/somepage.html" then this method would return {"/", "/foo", "/foo/bar"}. With a these paths one can fetch the content via the ContentRepository.getFolderByPath methods.
Convention is as follows:
/foo/bar/somepage.html -> {"/", "/foo", "/foo/bar"}
/foo/bar -> {"/" + "/foo"}
/foo -> {"/"}
/ -> {}

See Also:

ContentRepository.getFolderByPath, ContentRepository.getFoldersByPath

getAncestorFolderIds

java.lang.String[] getAncestorFolderIds()

Returns an array of ids for all folders which are parents of this item. If the item is the root folder then return an empty array.

See Also:

ContentRepository.getFolder, ContentRepository.getFolders