com.dotmarketing.portlets.folders.business
Interface FolderAPI

All Known Implementing Classes:
FolderAPIImpl

public interface FolderAPI

Author:
margaret

Field Summary
static java.lang.String SYSTEM_FOLDER
           
 
Method Summary
 java.util.List<java.lang.Object> buildNavigationTree(java.util.List items, int depth, com.liferay.portal.model.User user)
          Builds the Navigation Tree with the items
 void copy(Folder folderToCopy, Folder newParentFolder, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
          Will copy a folder to a new folder with all it contains.
 void copy(Folder folderToCopy, Host newParentHost, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
          Copies a folder to the root of another host
 Folder createFolders(java.lang.String path, Host host, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
          This method returns a new folder or the folder on the path you have passed in
 java.util.List<java.util.Map<java.lang.String,java.io.Serializable>> DBSearch(GenericQueryFactory.Query query, com.liferay.portal.model.User user, boolean respectFrontendRoles)
          Required by CMIS
 void delete(Folder folder, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
          Takes a folder and a user and deletes all underneath assets User needs edit permssions on folder to delete everything underneath
 boolean exists(java.lang.String folderInode)
          Does a folder already exist?
 Folder find(java.lang.String id, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
          find will hit first cache, and then db
 Folder findFolderByPath(java.lang.String path, Host host, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
          Find a folder by a Host and a path
 Folder findFolderByPath(java.lang.String path, java.lang.String hostid, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
          Find a folder by a Host and a path
 java.util.List<Folder> findFoldersByHost(Host host, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
          Pulls a complete list of all folders on a host
 java.util.List<Inode> findMenuItems(Folder folder, int orderDirection)
          Find the sorted Items of a folder
 java.util.List<Inode> findMenuItems(Folder folder, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
          Does a folder already exist?
 java.util.List<Inode> findMenuItems(Host host, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
          Find the Items of a host
 Folder findParentFolder(Treeable asset, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
          returns the parent folder for any given asset
 java.util.List<Folder> findSubFolders(Folder folder, boolean showOnMenu)
           
 java.util.List<Folder> findSubFolders(Folder folder, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
           
 java.util.List<Folder> findSubFolders(Host host, boolean showOnMenu)
           
 java.util.List<Folder> findSubFolders(Host host, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
           
 java.util.List<Folder> findSubFoldersRecursively(Folder folder, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
           
 java.util.List<Folder> findSubFoldersRecursively(Host host, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
           
 java.util.List<Folder> findSubFoldersTitleSort(Folder folder, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
          Find subFolders of a folder sort by Title
 Folder findSystemFolder()
           
 java.util.List<Folder> findThemes(Host host, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
           
 java.util.List<Contentlet> getContent(Folder parent, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
          Gets a list of 'working' Contentlet under given folder
 java.util.List<java.lang.String> getEntriesTree(Folder mainFolder, java.lang.String openNodes, java.lang.String view, java.lang.String content, java.lang.String structureInode, com.liferay.portal.model.User user)
           
 java.util.List<File> getFiles(Folder parent, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
          Gets a list of 'working' File under given folder
 java.util.List<File> getFiles(Folder parent, com.liferay.portal.model.User user, boolean respectFrontEndPermissions, ChildrenCondition cond)
          Gets a list of 'working' File under given folder
 java.util.List<java.lang.String> getFolderTree(java.lang.String openNodes, java.lang.String view, java.lang.String content, java.lang.String structureInode, com.liferay.portal.model.User user)
           
 java.util.List<HTMLPage> getHTMLPages(Folder parent, boolean working, boolean deleted, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
           
 java.util.List<HTMLPage> getHTMLPages(Folder parent, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
          Gets a list of 'working' HTMLPages under given folder
 java.util.List<HTMLPage> getHTMLPages(Host host, boolean working, boolean deleted, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
          Gets a list of HTMLPages under a given host
 java.util.List<HTMLPage> getHTMLPages(Host host, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
          Gets a list of 'working' HTMLPages under a given host
 java.util.List<Link> getLinks(Folder parent, boolean working, boolean deleted, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
           
 java.util.List<Link> getLinks(Folder parent, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
          Gets a list of 'working' Links under given folder
 java.util.List<Link> getLinks(Host host, boolean working, boolean deleted, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
           
 java.util.List<Link> getLinks(Host host, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
          Gets a list of 'working' Links under given host
 java.util.List<Contentlet> getLiveContent(Folder parent, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
           
 java.util.List<File> getLiveFiles(Folder parent, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
           
 java.util.List<File> getLiveFilesSortOrder(Folder parent, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
          returns child files sorted by title
 java.util.List<File> getLiveFilesSortTitle(Folder parent, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
          returns child files sorted by title
 java.util.List<HTMLPage> getLiveHTMLPages(Folder parent, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
           
 java.util.List<Link> getLiveLinks(Folder parent, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
           
 java.util.List<Structure> getStructures(Folder parent, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
          Gets a list of Structure under given folder
 java.util.List<Contentlet> getWorkingContent(Folder parent, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
           
 java.util.List<File> getWorkingFiles(Folder parent, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
           
 java.util.List<HTMLPage> getWorkingHTMLPages(Folder parent, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
           
 java.util.List<Link> getWorkingLinks(Folder parent, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
           
 boolean isChildFolder(Folder folder1, Folder folder2)
          Checks if folder1 is child of folder2
 boolean matchFilter(Folder folder, java.lang.String fileName)
           
 boolean move(Folder folderToMove, Folder newParentFolder, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
          Will move a folder to a new folder with all it contains.
 boolean move(Folder folderToMove, Host newParentHost, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
          Moves a folder to the root of another host
 boolean renameFolder(Folder folder, java.lang.String newName, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
          rename folder
 void save(Folder folder, java.lang.String existingId, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
          Saves a folder.
 void save(Folder folder, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
          Saves a folder.
 boolean updateIdentifierUrl(Folder folderToMove, Folder newParentFolder, com.liferay.portal.model.User user, boolean respectFrontEndPermissions)
          Will move a folder to a new folder with all it contains.
 

Field Detail

SYSTEM_FOLDER

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

findFolderByPath

Folder findFolderByPath(java.lang.String path,
                        Host host,
                        com.liferay.portal.model.User user,
                        boolean respectFrontEndPermissions)
                        throws DotStateException,
                               DotDataException,
                               DotSecurityException
Find a folder by a Host and a path

Parameters:
path -
hostId -
user -
respectFrontEndPermissions -
Returns:
Throws:
DotStateException
DotDataException
DotSecurityException

findFolderByPath

Folder findFolderByPath(java.lang.String path,
                        java.lang.String hostid,
                        com.liferay.portal.model.User user,
                        boolean respectFrontEndPermissions)
                        throws DotStateException,
                               DotDataException,
                               DotSecurityException
Find a folder by a Host and a path

Parameters:
path -
hostId -
user -
respectFrontEndPermissions -
Returns:
Throws:
DotStateException
DotDataException
DotSecurityException

renameFolder

boolean renameFolder(Folder folder,
                     java.lang.String newName,
                     com.liferay.portal.model.User user,
                     boolean respectFrontEndPermissions)
                     throws DotStateException,
                            DotDataException,
                            DotSecurityException
rename folder

Parameters:
folder -
newName -
user -
respectFrontEndPermissions -
Returns:
Throws:
DotStateException
DotDataException
DotSecurityException

findParentFolder

Folder findParentFolder(Treeable asset,
                        com.liferay.portal.model.User user,
                        boolean respectFrontEndPermissions)
                        throws DotIdentifierStateException,
                               DotDataException,
                               DotSecurityException
returns the parent folder for any given asset

Parameters:
asset -
Returns:
Throws:
DotIdentifierStateException
DotDataException
DotSecurityException

findSubFolders

java.util.List<Folder> findSubFolders(Folder folder,
                                      com.liferay.portal.model.User user,
                                      boolean respectFrontEndPermissions)
                                      throws DotStateException,
                                             DotDataException,
                                             DotSecurityException
Parameters:
folder -
Returns:
List of sub folders for passed in folder
Throws:
DotHibernateException
DotStateException
DotDataException
DotSecurityException

findSubFolders

java.util.List<Folder> findSubFolders(Host host,
                                      com.liferay.portal.model.User user,
                                      boolean respectFrontEndPermissions)
                                      throws DotStateException,
                                             DotDataException,
                                             DotSecurityException
Parameters:
folder -
Returns:
List of sub folders for passed in folder
Throws:
DotHibernateException
DotStateException
DotDataException
DotSecurityException

findThemes

java.util.List<Folder> findThemes(Host host,
                                  com.liferay.portal.model.User user,
                                  boolean respectFrontEndPermissions)
                                  throws DotStateException,
                                         DotDataException,
                                         DotSecurityException
Parameters:
host -
user -
respectFrontEndPermissions -
Returns:
List of themes for passed in host
Throws:
DotHibernateException
DotStateException
DotDataException
DotSecurityException

findSubFoldersRecursively

java.util.List<Folder> findSubFoldersRecursively(Folder folder,
                                                 com.liferay.portal.model.User user,
                                                 boolean respectFrontEndPermissions)
                                                 throws DotStateException,
                                                        DotDataException,
                                                        DotSecurityException
Parameters:
folder - Recursively
Returns:
List of sub folders for passed in folder
Throws:
DotHibernateException
DotStateException
DotDataException
DotSecurityException

findSubFoldersRecursively

java.util.List<Folder> findSubFoldersRecursively(Host host,
                                                 com.liferay.portal.model.User user,
                                                 boolean respectFrontEndPermissions)
                                                 throws DotStateException,
                                                        DotDataException,
                                                        DotSecurityException
Parameters:
folder -
Returns:
List of sub folders for passed in folder
Throws:
DotHibernateException
DotStateException
DotDataException
DotSecurityException

copy

void copy(Folder folderToCopy,
          Folder newParentFolder,
          com.liferay.portal.model.User user,
          boolean respectFrontEndPermissions)
          throws DotDataException,
                 DotSecurityException,
                 DotStateException,
                 java.io.IOException
Will copy a folder to a new folder with all it contains.

Parameters:
folderToCopy -
newParentFolder -
user -
respectFrontEndPermissions -
Throws:
DotDataException
java.io.IOException
DotStateException
DotSecurityException

copy

void copy(Folder folderToCopy,
          Host newParentHost,
          com.liferay.portal.model.User user,
          boolean respectFrontEndPermissions)
          throws DotDataException,
                 DotSecurityException,
                 DotStateException,
                 java.io.IOException
Copies a folder to the root of another host

Parameters:
folderToCopy -
newParentHost -
user -
respectFrontEndPermissions -
Throws:
DotDataException
DotSecurityException
java.io.IOException
DotStateException

exists

boolean exists(java.lang.String folderInode)
               throws DotDataException
Does a folder already exist?

Parameters:
path -
hostId -
Returns:
Throws:
DotHibernateException
DotDataException

findMenuItems

java.util.List<Inode> findMenuItems(Folder folder,
                                    com.liferay.portal.model.User user,
                                    boolean respectFrontEndPermissions)
                                    throws DotStateException,
                                           DotDataException
Does a folder already exist?

Parameters:
path -
hostId -
Returns:
Throws:
DotHibernateException
DotStateException
DotDataException

delete

void delete(Folder folder,
            com.liferay.portal.model.User user,
            boolean respectFrontEndPermissions)
            throws DotDataException,
                   DotSecurityException
Takes a folder and a user and deletes all underneath assets User needs edit permssions on folder to delete everything underneath

Parameters:
folder -
user -
respectFrontEndPermissions -
Throws:
DotDataException
DotSecurityException

getHTMLPages

java.util.List<HTMLPage> getHTMLPages(Folder parent,
                                      com.liferay.portal.model.User user,
                                      boolean respectFrontEndPermissions)
                                      throws DotStateException,
                                             DotDataException,
                                             DotSecurityException
Gets a list of 'working' HTMLPages under given folder

Parameters:
parent -
user -
respectFrontEndPermissions -
Returns:
Throws:
DotStateException
DotDataException
DotSecurityException

getHTMLPages

java.util.List<HTMLPage> getHTMLPages(Host host,
                                      com.liferay.portal.model.User user,
                                      boolean respectFrontEndPermissions)
                                      throws DotStateException,
                                             DotDataException,
                                             DotSecurityException
Gets a list of 'working' HTMLPages under a given host

Parameters:
host -
user -
respectFrontEndPermissions -
Returns:
Throws:
DotStateException
DotDataException
DotSecurityException

getHTMLPages

java.util.List<HTMLPage> getHTMLPages(Folder parent,
                                      boolean working,
                                      boolean deleted,
                                      com.liferay.portal.model.User user,
                                      boolean respectFrontEndPermissions)
                                      throws DotStateException,
                                             DotDataException,
                                             DotSecurityException
Throws:
DotStateException
DotDataException
DotSecurityException

getHTMLPages

java.util.List<HTMLPage> getHTMLPages(Host host,
                                      boolean working,
                                      boolean deleted,
                                      com.liferay.portal.model.User user,
                                      boolean respectFrontEndPermissions)
                                      throws DotStateException,
                                             DotDataException,
                                             DotSecurityException
Gets a list of HTMLPages under a given host

Parameters:
host -
working -
deleted -
user -
respectFrontEndPermissions -
Returns:
Throws:
DotStateException
DotDataException
DotSecurityException

getLinks

java.util.List<Link> getLinks(Folder parent,
                              com.liferay.portal.model.User user,
                              boolean respectFrontEndPermissions)
                              throws DotStateException,
                                     DotDataException,
                                     DotSecurityException
Gets a list of 'working' Links under given folder

Parameters:
parent -
user -
respectFrontEndPermissions -
Returns:
Throws:
DotStateException
DotDataException
DotSecurityException

getLinks

java.util.List<Link> getLinks(Host host,
                              com.liferay.portal.model.User user,
                              boolean respectFrontEndPermissions)
                              throws DotStateException,
                                     DotDataException,
                                     DotSecurityException
Gets a list of 'working' Links under given host

Parameters:
host -
user -
respectFrontEndPermissions -
Returns:
Throws:
DotStateException
DotDataException
DotSecurityException

getLinks

java.util.List<Link> getLinks(Folder parent,
                              boolean working,
                              boolean deleted,
                              com.liferay.portal.model.User user,
                              boolean respectFrontEndPermissions)
                              throws DotStateException,
                                     DotDataException,
                                     DotSecurityException
Throws:
DotStateException
DotDataException
DotSecurityException

getLinks

java.util.List<Link> getLinks(Host host,
                              boolean working,
                              boolean deleted,
                              com.liferay.portal.model.User user,
                              boolean respectFrontEndPermissions)
                              throws DotStateException,
                                     DotDataException,
                                     DotSecurityException
Throws:
DotStateException
DotDataException
DotSecurityException

getFiles

java.util.List<File> getFiles(Folder parent,
                              com.liferay.portal.model.User user,
                              boolean respectFrontEndPermissions)
                              throws DotStateException,
                                     DotDataException,
                                     DotSecurityException
Gets a list of 'working' File under given folder

Parameters:
parent -
user -
respectFrontEndPermissions -
Returns:
Throws:
DotStateException
DotDataException
DotSecurityException

getFiles

java.util.List<File> getFiles(Folder parent,
                              com.liferay.portal.model.User user,
                              boolean respectFrontEndPermissions,
                              ChildrenCondition cond)
                              throws DotStateException,
                                     DotDataException,
                                     DotSecurityException
Gets a list of 'working' File under given folder

Parameters:
parent -
user -
respectFrontEndPermissions -
condition -
Returns:
Throws:
DotStateException
DotDataException
DotSecurityException

getContent

java.util.List<Contentlet> getContent(Folder parent,
                                      com.liferay.portal.model.User user,
                                      boolean respectFrontEndPermissions)
                                      throws DotStateException,
                                             DotDataException,
                                             DotSecurityException
Gets a list of 'working' Contentlet under given folder

Parameters:
parent -
user -
respectFrontEndPermissions -
Returns:
Throws:
DotStateException
DotDataException
DotSecurityException

getStructures

java.util.List<Structure> getStructures(Folder parent,
                                        com.liferay.portal.model.User user,
                                        boolean respectFrontEndPermissions)
                                        throws DotStateException,
                                               DotDataException,
                                               DotSecurityException
Gets a list of Structure under given folder

Parameters:
parent -
user -
respectFrontEndPermissions -
Returns:
Throws:
DotStateException
DotDataException
DotSecurityException

find

Folder find(java.lang.String id,
            com.liferay.portal.model.User user,
            boolean respectFrontEndPermissions)
            throws DotHibernateException,
                   DotSecurityException,
                   DotDataException
find will hit first cache, and then db

Parameters:
id -
user -
respectFrontEndPermissions -
Returns:
Throws:
DotHibernateException
DotDataException
DotSecurityException

save

void save(Folder folder,
          com.liferay.portal.model.User user,
          boolean respectFrontEndPermissions)
          throws DotHibernateException,
                 DotSecurityException,
                 DotDataException
Saves a folder. The folder needs to have been created from the createFolder method, which will give it a valid identifier identifier

Parameters:
folder -
user -
respectFrontEndPermissions -
Throws:
DotHibernateException
DotSecurityException
DotDataException

save

void save(Folder folder,
          java.lang.String existingId,
          com.liferay.portal.model.User user,
          boolean respectFrontEndPermissions)
          throws DotHibernateException,
                 DotSecurityException,
                 DotDataException
Saves a folder. The folder needs to have been created from the createFolder method, which will give it a valid identifier identifier

Parameters:
folder -
existingId -
user -
respectFrontEndPermissions -
Throws:
DotHibernateException
DotSecurityException
DotDataException

findSystemFolder

Folder findSystemFolder()
                        throws DotDataException
Throws:
DotDataException

createFolders

Folder createFolders(java.lang.String path,
                     Host host,
                     com.liferay.portal.model.User user,
                     boolean respectFrontEndPermissions)
                     throws DotHibernateException,
                            DotSecurityException,
                            DotDataException
This method returns a new folder or the folder on the path you have passed in

Parameters:
path -
host -
user -
respectFrontEndPermissions -
Returns:
Throws:
DotHibernateException
DotSecurityException
DotDataException

findFoldersByHost

java.util.List<Folder> findFoldersByHost(Host host,
                                         com.liferay.portal.model.User user,
                                         boolean respectFrontEndPermissions)
                                         throws DotHibernateException,
                                                DotSecurityException
Pulls a complete list of all folders on a host

Parameters:
host -
user -
respectFrontEndPermissions -
Returns:
Throws:
DotHibernateException
DotSecurityException

DBSearch

java.util.List<java.util.Map<java.lang.String,java.io.Serializable>> DBSearch(GenericQueryFactory.Query query,
                                                                              com.liferay.portal.model.User user,
                                                                              boolean respectFrontendRoles)
                                                                              throws ValidationException,
                                                                                     DotDataException
Required by CMIS

Parameters:
query -
user -
respectFrontendRoles -
Returns:
Throws:
ValidationException
DotDataException

isChildFolder

boolean isChildFolder(Folder folder1,
                      Folder folder2)
                      throws DotDataException,
                             DotSecurityException
Checks if folder1 is child of folder2

Parameters:
folder1 -
folder2 -
Returns:
Throws:
DotDataException
DotSecurityException
DotSecurityException

matchFilter

boolean matchFilter(Folder folder,
                    java.lang.String fileName)
Parameters:
folder -
fileName -
Returns:

findMenuItems

java.util.List<Inode> findMenuItems(Folder folder,
                                    int orderDirection)
                                    throws DotDataException
Find the sorted Items of a folder

Parameters:
folder -
orderDirection -
Returns:
Throws:
DotDataException

buildNavigationTree

java.util.List<java.lang.Object> buildNavigationTree(java.util.List items,
                                                     int depth,
                                                     com.liferay.portal.model.User user)
                                                     throws DotDataException
Builds the Navigation Tree with the items

Parameters:
items -
depth -
user -
Returns:
Throws:
DotDataException

findMenuItems

java.util.List<Inode> findMenuItems(Host host,
                                    com.liferay.portal.model.User user,
                                    boolean respectFrontEndPermissions)
                                    throws DotDataException,
                                           DotSecurityException
Find the Items of a host

Parameters:
host -
user -
respectFrontEndPermissions -
Returns:
Throws:
DotDataException
DotSecurityException

findSubFoldersTitleSort

java.util.List<Folder> findSubFoldersTitleSort(Folder folder,
                                               com.liferay.portal.model.User user,
                                               boolean respectFrontEndPermissions)
                                               throws DotDataException
Find subFolders of a folder sort by Title

Parameters:
folder -
user -
respectFrontEndPermissions -
Returns:
Throws:
DotDataException

move

boolean move(Folder folderToMove,
             Folder newParentFolder,
             com.liferay.portal.model.User user,
             boolean respectFrontEndPermissions)
             throws DotDataException,
                    DotSecurityException
Will move a folder to a new folder with all it contains.

Parameters:
folderToMove -
newParentFolder -
user -
respectFrontEndPermissions -
Returns:
Throws:
DotDataException
DotSecurityException

move

boolean move(Folder folderToMove,
             Host newParentHost,
             com.liferay.portal.model.User user,
             boolean respectFrontEndPermissions)
             throws DotDataException,
                    DotSecurityException
Moves a folder to the root of another host

Parameters:
folderToMove -
newParentHost -
user -
respectFrontEndPermissions -
Returns:
Throws:
DotDataException
DotSecurityException

findSubFolders

java.util.List<Folder> findSubFolders(Host host,
                                      boolean showOnMenu)
                                      throws DotHibernateException
Parameters:
host -
showOnMenu -
Returns:
Throws:
DotHibernateException

findSubFolders

java.util.List<Folder> findSubFolders(Folder folder,
                                      boolean showOnMenu)
                                      throws DotStateException,
                                             DotDataException
Parameters:
folder -
showOnMenu -
Returns:
Throws:
DotStateException
DotDataException

getEntriesTree

java.util.List<java.lang.String> getEntriesTree(Folder mainFolder,
                                                java.lang.String openNodes,
                                                java.lang.String view,
                                                java.lang.String content,
                                                java.lang.String structureInode,
                                                com.liferay.portal.model.User user)
                                                throws DotStateException,
                                                       DotDataException,
                                                       DotSecurityException
Parameters:
mainFolder -
openNodes -
view -
content -
structureInode -
user -
Returns:
Throws:
DotStateException
DotDataException
DotSecurityException

getFolderTree

java.util.List<java.lang.String> getFolderTree(java.lang.String openNodes,
                                               java.lang.String view,
                                               java.lang.String content,
                                               java.lang.String structureInode,
                                               com.liferay.portal.model.User user)
                                               throws DotStateException,
                                                      DotDataException,
                                                      DotSecurityException
Parameters:
openNodes -
view -
content -
structureInode -
user -
Returns:
Throws:
DotStateException
DotDataException
DotSecurityException

getWorkingHTMLPages

java.util.List<HTMLPage> getWorkingHTMLPages(Folder parent,
                                             com.liferay.portal.model.User user,
                                             boolean respectFrontEndPermissions)
                                             throws DotDataException,
                                                    DotSecurityException
Parameters:
parent -
user -
respectFrontEndPermissions -
Returns:
Throws:
DotDataException
DotSecurityException

getWorkingLinks

java.util.List<Link> getWorkingLinks(Folder parent,
                                     com.liferay.portal.model.User user,
                                     boolean respectFrontEndPermissions)
                                     throws DotDataException,
                                            DotSecurityException
Parameters:
parent -
user -
respectFrontEndPermissions -
Returns:
Throws:
DotDataException
DotSecurityException

getWorkingFiles

java.util.List<File> getWorkingFiles(Folder parent,
                                     com.liferay.portal.model.User user,
                                     boolean respectFrontEndPermissions)
                                     throws DotDataException,
                                            DotSecurityException
Parameters:
parent -
user -
respectFrontEndPermissions -
Returns:
Throws:
DotDataException
DotSecurityException

getWorkingContent

java.util.List<Contentlet> getWorkingContent(Folder parent,
                                             com.liferay.portal.model.User user,
                                             boolean respectFrontEndPermissions)
                                             throws DotDataException,
                                                    DotSecurityException
Parameters:
parent -
user -
respectFrontEndPermissions -
Returns:
Throws:
DotDataException
DotSecurityException

getLiveHTMLPages

java.util.List<HTMLPage> getLiveHTMLPages(Folder parent,
                                          com.liferay.portal.model.User user,
                                          boolean respectFrontEndPermissions)
                                          throws DotDataException,
                                                 DotSecurityException
Parameters:
parent -
user -
respectFrontEndPermissions -
Returns:
Throws:
DotDataException
DotSecurityException

getLiveLinks

java.util.List<Link> getLiveLinks(Folder parent,
                                  com.liferay.portal.model.User user,
                                  boolean respectFrontEndPermissions)
                                  throws DotDataException,
                                         DotSecurityException
Parameters:
parent -
user -
respectFrontEndPermissions -
Returns:
Throws:
DotDataException
DotSecurityException

getLiveFiles

java.util.List<File> getLiveFiles(Folder parent,
                                  com.liferay.portal.model.User user,
                                  boolean respectFrontEndPermissions)
                                  throws DotDataException,
                                         DotSecurityException
Parameters:
parent -
user -
respectFrontEndPermissions -
Returns:
Throws:
DotDataException
DotSecurityException

getLiveFilesSortTitle

java.util.List<File> getLiveFilesSortTitle(Folder parent,
                                           com.liferay.portal.model.User user,
                                           boolean respectFrontEndPermissions)
                                           throws DotDataException,
                                                  DotSecurityException
returns child files sorted by title

Parameters:
parent -
user -
respectFrontEndPermissions -
Returns:
Throws:
DotDataException
DotSecurityException

getLiveFilesSortOrder

java.util.List<File> getLiveFilesSortOrder(Folder parent,
                                           com.liferay.portal.model.User user,
                                           boolean respectFrontEndPermissions)
                                           throws DotDataException,
                                                  DotSecurityException
returns child files sorted by title

Parameters:
parent -
user -
respectFrontEndPermissions -
Returns:
Throws:
DotDataException
DotSecurityException

getLiveContent

java.util.List<Contentlet> getLiveContent(Folder parent,
                                          com.liferay.portal.model.User user,
                                          boolean respectFrontEndPermissions)
                                          throws DotDataException,
                                                 DotSecurityException
Parameters:
parent -
user -
respectFrontEndPermissions -
Returns:
Throws:
DotDataException
DotSecurityException

updateIdentifierUrl

boolean updateIdentifierUrl(Folder folderToMove,
                            Folder newParentFolder,
                            com.liferay.portal.model.User user,
                            boolean respectFrontEndPermissions)
                            throws DotDataException,
                                   DotSecurityException
Will move a folder to a new folder with all it contains.

Parameters:
folderToMove -
newParentFolder -
user -
respectFrontEndPermissions -
Returns:
Throws:
DotDataException
DotSecurityException


Copyright © 2013 dotCMS Inc. All Rights Reserved.