|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface FolderAPI
| 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 |
|---|
static final java.lang.String SYSTEM_FOLDER
| Method Detail |
|---|
Folder findFolderByPath(java.lang.String path,
Host host,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotStateException,
DotDataException,
DotSecurityException
path - hostId - user - respectFrontEndPermissions -
DotStateException
DotDataException
DotSecurityException
Folder findFolderByPath(java.lang.String path,
java.lang.String hostid,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotStateException,
DotDataException,
DotSecurityException
path - hostId - user - respectFrontEndPermissions -
DotStateException
DotDataException
DotSecurityException
boolean renameFolder(Folder folder,
java.lang.String newName,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotStateException,
DotDataException,
DotSecurityException
folder - newName - user - respectFrontEndPermissions -
DotStateException
DotDataException
DotSecurityException
Folder findParentFolder(Treeable asset,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotIdentifierStateException,
DotDataException,
DotSecurityException
asset -
DotIdentifierStateException
DotDataException
DotSecurityException
java.util.List<Folder> findSubFolders(Folder folder,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotStateException,
DotDataException,
DotSecurityException
folder -
DotHibernateException
DotStateException
DotDataException
DotSecurityException
java.util.List<Folder> findSubFolders(Host host,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotStateException,
DotDataException,
DotSecurityException
folder -
DotHibernateException
DotStateException
DotDataException
DotSecurityException
java.util.List<Folder> findThemes(Host host,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotStateException,
DotDataException,
DotSecurityException
host - user - respectFrontEndPermissions -
DotHibernateException
DotStateException
DotDataException
DotSecurityException
java.util.List<Folder> findSubFoldersRecursively(Folder folder,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotStateException,
DotDataException,
DotSecurityException
folder - Recursively
DotHibernateException
DotStateException
DotDataException
DotSecurityException
java.util.List<Folder> findSubFoldersRecursively(Host host,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotStateException,
DotDataException,
DotSecurityException
folder -
DotHibernateException
DotStateException
DotDataException
DotSecurityException
void copy(Folder folderToCopy,
Folder newParentFolder,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotDataException,
DotSecurityException,
DotStateException,
java.io.IOException
folderToCopy - newParentFolder - user - respectFrontEndPermissions -
DotDataException
java.io.IOException
DotStateException
DotSecurityException
void copy(Folder folderToCopy,
Host newParentHost,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotDataException,
DotSecurityException,
DotStateException,
java.io.IOException
folderToCopy - newParentHost - user - respectFrontEndPermissions -
DotDataException
DotSecurityException
java.io.IOException
DotStateException
boolean exists(java.lang.String folderInode)
throws DotDataException
path - hostId -
DotHibernateException
DotDataException
java.util.List<Inode> findMenuItems(Folder folder,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotStateException,
DotDataException
path - hostId -
DotHibernateException
DotStateException
DotDataException
void delete(Folder folder,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotDataException,
DotSecurityException
folder - user - respectFrontEndPermissions -
DotDataException
DotSecurityException
java.util.List<HTMLPage> getHTMLPages(Folder parent,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotStateException,
DotDataException,
DotSecurityException
parent - user - respectFrontEndPermissions -
DotStateException
DotDataException
DotSecurityException
java.util.List<HTMLPage> getHTMLPages(Host host,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotStateException,
DotDataException,
DotSecurityException
host - user - respectFrontEndPermissions -
DotStateException
DotDataException
DotSecurityException
java.util.List<HTMLPage> getHTMLPages(Folder parent,
boolean working,
boolean deleted,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotStateException,
DotDataException,
DotSecurityException
DotStateException
DotDataException
DotSecurityException
java.util.List<HTMLPage> getHTMLPages(Host host,
boolean working,
boolean deleted,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotStateException,
DotDataException,
DotSecurityException
host - working - deleted - user - respectFrontEndPermissions -
DotStateException
DotDataException
DotSecurityException
java.util.List<Link> getLinks(Folder parent,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotStateException,
DotDataException,
DotSecurityException
parent - user - respectFrontEndPermissions -
DotStateException
DotDataException
DotSecurityException
java.util.List<Link> getLinks(Host host,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotStateException,
DotDataException,
DotSecurityException
host - user - respectFrontEndPermissions -
DotStateException
DotDataException
DotSecurityException
java.util.List<Link> getLinks(Folder parent,
boolean working,
boolean deleted,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotStateException,
DotDataException,
DotSecurityException
DotStateException
DotDataException
DotSecurityException
java.util.List<Link> getLinks(Host host,
boolean working,
boolean deleted,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotStateException,
DotDataException,
DotSecurityException
DotStateException
DotDataException
DotSecurityException
java.util.List<File> getFiles(Folder parent,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotStateException,
DotDataException,
DotSecurityException
parent - user - respectFrontEndPermissions -
DotStateException
DotDataException
DotSecurityException
java.util.List<File> getFiles(Folder parent,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions,
ChildrenCondition cond)
throws DotStateException,
DotDataException,
DotSecurityException
parent - user - respectFrontEndPermissions - condition -
DotStateException
DotDataException
DotSecurityException
java.util.List<Contentlet> getContent(Folder parent,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotStateException,
DotDataException,
DotSecurityException
parent - user - respectFrontEndPermissions -
DotStateException
DotDataException
DotSecurityException
java.util.List<Structure> getStructures(Folder parent,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotStateException,
DotDataException,
DotSecurityException
parent - user - respectFrontEndPermissions -
DotStateException
DotDataException
DotSecurityException
Folder find(java.lang.String id,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotHibernateException,
DotSecurityException,
DotDataException
id - user - respectFrontEndPermissions -
DotHibernateException
DotDataException
DotSecurityException
void save(Folder folder,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotHibernateException,
DotSecurityException,
DotDataException
folder - user - respectFrontEndPermissions -
DotHibernateException
DotSecurityException
DotDataException
void save(Folder folder,
java.lang.String existingId,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotHibernateException,
DotSecurityException,
DotDataException
folder - existingId - user - respectFrontEndPermissions -
DotHibernateException
DotSecurityException
DotDataException
Folder findSystemFolder()
throws DotDataException
DotDataException
Folder createFolders(java.lang.String path,
Host host,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotHibernateException,
DotSecurityException,
DotDataException
path - host - user - respectFrontEndPermissions -
DotHibernateException
DotSecurityException
DotDataException
java.util.List<Folder> findFoldersByHost(Host host,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotHibernateException,
DotSecurityException
host - user - respectFrontEndPermissions -
DotHibernateException
DotSecurityException
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
query - user - respectFrontendRoles -
ValidationException
DotDataException
boolean isChildFolder(Folder folder1,
Folder folder2)
throws DotDataException,
DotSecurityException
folder1 - folder2 -
DotDataException
DotSecurityException
DotSecurityException
boolean matchFilter(Folder folder,
java.lang.String fileName)
folder - fileName -
java.util.List<Inode> findMenuItems(Folder folder,
int orderDirection)
throws DotDataException
folder - orderDirection -
DotDataException
java.util.List<java.lang.Object> buildNavigationTree(java.util.List items,
int depth,
com.liferay.portal.model.User user)
throws DotDataException
items - depth - user -
DotDataException
java.util.List<Inode> findMenuItems(Host host,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotDataException,
DotSecurityException
host - user - respectFrontEndPermissions -
DotDataException
DotSecurityException
java.util.List<Folder> findSubFoldersTitleSort(Folder folder,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotDataException
folder - user - respectFrontEndPermissions -
DotDataException
boolean move(Folder folderToMove,
Folder newParentFolder,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotDataException,
DotSecurityException
folderToMove - newParentFolder - user - respectFrontEndPermissions -
DotDataException
DotSecurityException
boolean move(Folder folderToMove,
Host newParentHost,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotDataException,
DotSecurityException
folderToMove - newParentHost - user - respectFrontEndPermissions -
DotDataException
DotSecurityException
java.util.List<Folder> findSubFolders(Host host,
boolean showOnMenu)
throws DotHibernateException
host - showOnMenu -
DotHibernateException
java.util.List<Folder> findSubFolders(Folder folder,
boolean showOnMenu)
throws DotStateException,
DotDataException
folder - showOnMenu -
DotStateException
DotDataException
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
mainFolder - openNodes - view - content - structureInode - user -
DotStateException
DotDataException
DotSecurityException
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
openNodes - view - content - structureInode - user -
DotStateException
DotDataException
DotSecurityException
java.util.List<HTMLPage> getWorkingHTMLPages(Folder parent,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotDataException,
DotSecurityException
parent - user - respectFrontEndPermissions -
DotDataException
DotSecurityException
java.util.List<Link> getWorkingLinks(Folder parent,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotDataException,
DotSecurityException
parent - user - respectFrontEndPermissions -
DotDataException
DotSecurityException
java.util.List<File> getWorkingFiles(Folder parent,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotDataException,
DotSecurityException
parent - user - respectFrontEndPermissions -
DotDataException
DotSecurityException
java.util.List<Contentlet> getWorkingContent(Folder parent,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotDataException,
DotSecurityException
parent - user - respectFrontEndPermissions -
DotDataException
DotSecurityException
java.util.List<HTMLPage> getLiveHTMLPages(Folder parent,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotDataException,
DotSecurityException
parent - user - respectFrontEndPermissions -
DotDataException
DotSecurityException
java.util.List<Link> getLiveLinks(Folder parent,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotDataException,
DotSecurityException
parent - user - respectFrontEndPermissions -
DotDataException
DotSecurityException
java.util.List<File> getLiveFiles(Folder parent,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotDataException,
DotSecurityException
parent - user - respectFrontEndPermissions -
DotDataException
DotSecurityException
java.util.List<File> getLiveFilesSortTitle(Folder parent,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotDataException,
DotSecurityException
parent - user - respectFrontEndPermissions -
DotDataException
DotSecurityException
java.util.List<File> getLiveFilesSortOrder(Folder parent,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotDataException,
DotSecurityException
parent - user - respectFrontEndPermissions -
DotDataException
DotSecurityException
java.util.List<Contentlet> getLiveContent(Folder parent,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotDataException,
DotSecurityException
parent - user - respectFrontEndPermissions -
DotDataException
DotSecurityException
boolean updateIdentifierUrl(Folder folderToMove,
Folder newParentFolder,
com.liferay.portal.model.User user,
boolean respectFrontEndPermissions)
throws DotDataException,
DotSecurityException
folderToMove - newParentFolder - user - respectFrontEndPermissions -
DotDataException
DotSecurityException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||