org.alfresco.util.config
Class RepositoryFolderConfigBean

java.lang.Object
  extended by org.alfresco.util.config.RepositoryPathConfigBean
      extended by org.alfresco.util.config.RepositoryFolderConfigBean
Direct Known Subclasses:
ImapConfigMountPointsBean

public class RepositoryFolderConfigBean
extends RepositoryPathConfigBean

Composite property bean to identify a folder in the repository. This uses the path to identify a root and then a folder-name path to identify a folder.

Since:
3.2

Constructor Summary
RepositoryFolderConfigBean()
           
 
Method Summary
 java.util.List getFolderNames()
          Get the folder name path
 java.lang.String getFolderPath()
           
 org.alfresco.service.cmr.repository.NodeRef getFolderPath(org.alfresco.service.namespace.NamespaceService namespaceService, org.alfresco.service.cmr.repository.NodeService nodeService, org.alfresco.service.cmr.search.SearchService searchService, FileFolderService fileFolderService)
          Helper method to find the folder path referenced by this bean.
 org.alfresco.service.cmr.repository.NodeRef getOrCreateFolderPath(org.alfresco.service.namespace.NamespaceService namespaceService, org.alfresco.service.cmr.repository.NodeService nodeService, org.alfresco.service.cmr.search.SearchService searchService, FileFolderService fileFolderService)
          Helper method to find or create the folder path referenced by this bean.
 void setFolderPath(java.lang.String folderPath)
          Set the folder name path relative to the path.
 java.lang.String toString()
           
 
Methods inherited from class org.alfresco.util.config.RepositoryPathConfigBean
getRootPath, getStore, getStoreRef, resolveNodePath, setRootPath, setStore
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RepositoryFolderConfigBean

public RepositoryFolderConfigBean()
Method Detail

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getFolderNames

public java.util.List getFolderNames()
Get the folder name path


getFolderPath

public java.lang.String getFolderPath()
Returns:
Returns the string representation of the folder path

setFolderPath

public void setFolderPath(java.lang.String folderPath)
Set the folder name path relative to the path.

Parameters:
folderPath - a folder-name path using the '/' path separator e.g. 'IMAP HOME/MAIL-1'

getFolderPath

public org.alfresco.service.cmr.repository.NodeRef getFolderPath(org.alfresco.service.namespace.NamespaceService namespaceService,
                                                                 org.alfresco.service.cmr.repository.NodeService nodeService,
                                                                 org.alfresco.service.cmr.search.SearchService searchService,
                                                                 FileFolderService fileFolderService)
Helper method to find the folder path referenced by this bean. The path to the start of the folder path must exist.

Authentication and transactions are the client's responsibility.

Returns:
Returns an existing folder reference or null

getOrCreateFolderPath

public org.alfresco.service.cmr.repository.NodeRef getOrCreateFolderPath(org.alfresco.service.namespace.NamespaceService namespaceService,
                                                                         org.alfresco.service.cmr.repository.NodeService nodeService,
                                                                         org.alfresco.service.cmr.search.SearchService searchService,
                                                                         FileFolderService fileFolderService)
Helper method to find or create the folder path referenced by this bean. The path to the start of the folder path must exist. The folder path will be created, if required.

Authentication and transactions are the client's responsibility.

Returns:
Returns an existing or new folder reference


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.