atg.repository.content
Interface ContentRepositoryFolder

All Superinterfaces:
DisplayableItem, FolderItem
All Known Implementing Classes:
GenericSecuredMutableFolderItem

public interface ContentRepositoryFolder
extends FolderItem

Defines an interface which describes a set of information on folders required by the Dynamo GUIs.


Field Summary
static java.lang.String CLASS_VERSION
           
 
Method Summary
 java.lang.String[] getChildContentIds()
          Returns an array of document ids which can be used to access the pieces of content in the folder.
 java.lang.String[] getChildContentPaths()
          Returns an array of document names which can be used to access the pieces of content in the folder.
 java.lang.String[] getChildFolderIds()
          Returns an array of ids which access all the folders which are children of this folder.
 java.lang.String[] getChildFolderPaths()
          Returns an array of folder names which access all the folders which are children of this folder.
 java.lang.String getFolderId()
          Return the id of this folder.
 
Methods inherited from interface atg.repository.content.FolderItem
getAncestorFolderIds, getAncestorFolderPaths, getItemPath
 
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

getFolderId

java.lang.String getFolderId()
Return the id of this folder.


getChildFolderPaths

java.lang.String[] getChildFolderPaths()
Returns an array of folder names which access all the folders which are children of this folder.

See Also:
ContentRepository.getFolderByPath, ContentRepository.getFoldersByPath

getChildFolderIds

java.lang.String[] getChildFolderIds()
Returns an array of ids which access all the folders which are children of this folder.

See Also:
ContentRepository.getFolder, ContentRepository.getFolders

getChildContentPaths

java.lang.String[] getChildContentPaths()
Returns an array of document names which can be used to access the pieces of content in the folder.

Returns:
an array of full paths for documents contained within this folder. e.g. ["/foo/bar.html", "/foobar.html"]
See Also:
ContentRepository.getItemByPath, ContentRepository.getItemsByPath

getChildContentIds

java.lang.String[] getChildContentIds()
Returns an array of document ids which can be used to access the pieces of content in the folder.

See Also:
Repository.getItem, Repository.getItems