atg.repository.content
Interface ContentRepository

All Superinterfaces:
Repository, RepositoryViewContainer
All Known Implementing Classes:
atg.repository.content.ContentRepositoryService, GenericSecuredMutableContentRepository, atg.adapter.html.ImmutableSimpleRepository, SimpleRepository, XMLRepositoryService

public interface ContentRepository
extends Repository


Field Summary
static java.lang.String CLASS_VERSION
           
 
Method Summary
 atg.repository.content.ContentRootPathProvider getContentRootPathProvider()
          Returns the ContentRootPathProvider component that determines the base path of content items living on the filesystem.
 ContentRepositoryFolder getFolder(java.lang.String pId)
          Returns a folder by it's id
 ContentRepositoryFolder getFolderByPath(java.lang.String pPath)
          Returns a folder based on the supplied path.
 ContentRepositoryFolder[] getFolders(java.lang.String[] pIds)
          Returns a set of folders with the given ids
 ContentRepositoryFolder[] getFoldersByPath(java.lang.String[] pPaths)
          Returns a set of folders based on the supplied paths.
 ContentRepositoryItem getItemByPath(java.lang.String pPath)
          Returns a document based on the supplied path.
 ContentRepositoryItem[] getItemsByPath(java.lang.String[] pPaths)
          Returns a set of document based on the supplied paths.
 java.lang.String getPathSeparator()
          Returns the String which represents the path seperator for the path names of the items in the repository
 ContentRepositoryFolder getRootFolder()
          Returns the folder which points toward the "root folder."
 void setContentRootPathProvider(atg.repository.content.ContentRootPathProvider pContentRootPathProvider)
          Sets the ContentRootPathProvider component that determines the base path of content items living on the filesystem.
 
Methods inherited from interface atg.repository.Repository
getDefaultViewName, getItem, getItem, getItemDescriptor, getItemDescriptor, getItemDescriptorNames, getItems, getItems, getRepositoryName, getView, getView, getViewNames
 

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION
See Also:
Constant Field Values
Method Detail

getItemByPath

ContentRepositoryItem getItemByPath(java.lang.String pPath)
                                    throws RepositoryException
Returns a document based on the supplied path.

Parameters:
pPath - a value which represents the "name" of the document. e.g. "/foo/bar.html"
Throws:
RepositoryException

getItemsByPath

ContentRepositoryItem[] getItemsByPath(java.lang.String[] pPaths)
                                       throws RepositoryException
Returns a set of document based on the supplied paths.

Parameters:
pPaths - an array of paths, each of which represents the "name" of a single document. e.g. "/foo/bar.html"
Throws:
RepositoryException

getRootFolder

ContentRepositoryFolder getRootFolder()
                                      throws RepositoryException
Returns the folder which points toward the "root folder."

Throws:
RepositoryException

getFolder

ContentRepositoryFolder getFolder(java.lang.String pId)
                                  throws RepositoryException
Returns a folder by it's id

Throws:
RepositoryException

getFolders

ContentRepositoryFolder[] getFolders(java.lang.String[] pIds)
                                     throws RepositoryException
Returns a set of folders with the given ids

Throws:
RepositoryException

getFolderByPath

ContentRepositoryFolder getFolderByPath(java.lang.String pPath)
                                        throws RepositoryException
Returns a folder based on the supplied path.

Parameters:
pPath - a value which represents the "name" of the folder. e.g. "/foo/bar/"
Throws:
RepositoryException

getFoldersByPath

ContentRepositoryFolder[] getFoldersByPath(java.lang.String[] pPaths)
                                           throws RepositoryException
Returns a set of folders based on the supplied paths.

Parameters:
pPaths - an array of paths, each of which represents the "name" of a single folder. e.g. "/foo/bar/"
Throws:
RepositoryException

getPathSeparator

java.lang.String getPathSeparator()
Returns the String which represents the path seperator for the path names of the items in the repository


setContentRootPathProvider

void setContentRootPathProvider(atg.repository.content.ContentRootPathProvider pContentRootPathProvider)
Sets the ContentRootPathProvider component that determines the base path of content items living on the filesystem.

Parameters:
pContentRootPathProvider - the component providing this service

getContentRootPathProvider

atg.repository.content.ContentRootPathProvider getContentRootPathProvider()
Returns the ContentRootPathProvider component that determines the base path of content items living on the filesystem.

Returns:
the ContentRootPathProvider component providing this service