com.liferay.journal.service

Interface JournalFolderService

All Superinterfaces:

BaseService

All Known Implementing Classes:

JournalFolderServiceWrapper

@AccessControlled
 @JSONWebService
 @ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface JournalFolderService
extends BaseService

Provides the remote service interface for JournalFolder. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

See Also:

JournalFolderServiceUtil

Method Summary

Modifier and Type	Method and Description
JournalFolder	addFolder(long groupId, long parentFolderId, java.lang.String name, java.lang.String description, ServiceContext serviceContext)
void	deleteFolder(long folderId)
void	deleteFolder(long folderId, boolean includeTrashedEntries)
JournalFolder	fetchFolder(long folderId)
java.util.List<DDMStructure>	getDDMStructures(long[] groupIds, long folderId, int restrictionType)
JournalFolder	getFolder(long folderId)
java.util.List<java.lang.Long>	getFolderIds(long groupId, long folderId)
java.util.List<JournalFolder>	getFolders(long groupId)
java.util.List<JournalFolder>	getFolders(long groupId, long parentFolderId)
java.util.List<JournalFolder>	getFolders(long groupId, long parentFolderId, int status)
java.util.List<JournalFolder>	getFolders(long groupId, long parentFolderId, int start, int end)
java.util.List<JournalFolder>	getFolders(long groupId, long parentFolderId, int status, int start, int end)
java.util.List<java.lang.Object>	getFoldersAndArticles(long groupId, long folderId, int status, int start, int end, OrderByComparator<?> orderByComparator)
java.util.List<java.lang.Object>	getFoldersAndArticles(long groupId, long folderId, int start, int end, OrderByComparator<?> orderByComparator)
java.util.List<java.lang.Object>	getFoldersAndArticles(long groupId, long userId, long folderId, int status, int start, int end, OrderByComparator<?> orderByComparator)
java.util.List<java.lang.Object>	getFoldersAndArticles(long groupId, long userId, long folderId, int status, java.util.Locale locale, int start, int end, OrderByComparator<?> orderByComparator)
int	getFoldersAndArticlesCount(long groupId, java.util.List<java.lang.Long> folderIds, int status)
int	getFoldersAndArticlesCount(long groupId, long folderId)
int	getFoldersAndArticlesCount(long groupId, long folderId, int status)
int	getFoldersAndArticlesCount(long groupId, long userId, long folderId, int status)
int	getFoldersCount(long groupId, long parentFolderId)
int	getFoldersCount(long groupId, long parentFolderId, int status)
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
void	getSubfolderIds(java.util.List<java.lang.Long> folderIds, long groupId, long folderId, boolean recurse)
java.util.List<java.lang.Long>	getSubfolderIds(long groupId, long folderId, boolean recurse)
JournalFolder	moveFolder(long folderId, long parentFolderId, ServiceContext serviceContext)
JournalFolder	moveFolderFromTrash(long folderId, long parentFolderId, ServiceContext serviceContext)
JournalFolder	moveFolderToTrash(long folderId)
void	restoreFolderFromTrash(long folderId)
java.util.List<DDMStructure>	searchDDMStructures(long companyId, long[] groupIds, long folderId, int restrictionType, java.lang.String keywords, int start, int end, OrderByComparator<DDMStructure> orderByComparator)
void	subscribe(long groupId, long folderId)
void	unsubscribe(long groupId, long folderId)
JournalFolder	updateFolder(long groupId, long folderId, long parentFolderId, java.lang.String name, java.lang.String description, boolean mergeWithParentFolder, ServiceContext serviceContext)
JournalFolder	updateFolder(long groupId, long folderId, long parentFolderId, java.lang.String name, java.lang.String description, long[] ddmStructureIds, int restrictionType, boolean mergeWithParentFolder, ServiceContext serviceContext)

Method Detail

addFolder

JournalFolder addFolder(long groupId,
                        long parentFolderId,
                        java.lang.String name,
                        java.lang.String description,
                        ServiceContext serviceContext)
                 throws PortalException

Throws:

PortalException

deleteFolder

void deleteFolder(long folderId)
           throws PortalException

Throws:

PortalException

deleteFolder

void deleteFolder(long folderId,
                  boolean includeTrashedEntries)
           throws PortalException

Throws:

PortalException

fetchFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalFolder fetchFolder(long folderId)
                                                                                      throws PortalException

Throws:

PortalException

getDDMStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMStructure> getDDMStructures(long[] groupIds,
                                                                                                                 long folderId,
                                                                                                                 int restrictionType)
                                                                                                          throws PortalException

Throws:

PortalException

getFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalFolder getFolder(long folderId)
                                                                                    throws PortalException

Throws:

PortalException

getFolderIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<java.lang.Long> getFolderIds(long groupId,
                                                                                                               long folderId)
                                                                                                        throws PortalException

Throws:

PortalException

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<JournalFolder> getFolders(long groupId)

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<JournalFolder> getFolders(long groupId,
                                                                                                            long parentFolderId)

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<JournalFolder> getFolders(long groupId,
                                                                                                            long parentFolderId,
                                                                                                            int status)

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<JournalFolder> getFolders(long groupId,
                                                                                                            long parentFolderId,
                                                                                                            int start,
                                                                                                            int end)

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<JournalFolder> getFolders(long groupId,
                                                                                                            long parentFolderId,
                                                                                                            int status,
                                                                                                            int start,
                                                                                                            int end)

getFoldersAndArticles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<java.lang.Object> getFoldersAndArticles(long groupId,
                                                                                                                          long folderId,
                                                                                                                          int status,
                                                                                                                          int start,
                                                                                                                          int end,
                                                                                                                          OrderByComparator<?> orderByComparator)

getFoldersAndArticles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<java.lang.Object> getFoldersAndArticles(long groupId,
                                                                                                                          long folderId,
                                                                                                                          int start,
                                                                                                                          int end,
                                                                                                                          OrderByComparator<?> orderByComparator)

getFoldersAndArticles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<java.lang.Object> getFoldersAndArticles(long groupId,
                                                                                                                          long userId,
                                                                                                                          long folderId,
                                                                                                                          int status,
                                                                                                                          int start,
                                                                                                                          int end,
                                                                                                                          OrderByComparator<?> orderByComparator)

getFoldersAndArticles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<java.lang.Object> getFoldersAndArticles(long groupId,
                                                                                                                          long userId,
                                                                                                                          long folderId,
                                                                                                                          int status,
                                                                                                                          java.util.Locale locale,
                                                                                                                          int start,
                                                                                                                          int end,
                                                                                                                          OrderByComparator<?> orderByComparator)

getFoldersAndArticlesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersAndArticlesCount(long groupId,
                                                                                                  java.util.List<java.lang.Long> folderIds,
                                                                                                  int status)

getFoldersAndArticlesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersAndArticlesCount(long groupId,
                                                                                                  long folderId)

getFoldersAndArticlesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersAndArticlesCount(long groupId,
                                                                                                  long folderId,
                                                                                                  int status)

getFoldersAndArticlesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersAndArticlesCount(long groupId,
                                                                                                  long userId,
                                                                                                  long folderId,
                                                                                                  int status)

getFoldersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersCount(long groupId,
                                                                                       long parentFolderId)

getFoldersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersCount(long groupId,
                                                                                       long parentFolderId,
                                                                                       int status)

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getSubfolderIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
void getSubfolderIds(java.util.List<java.lang.Long> folderIds,
                                                                                        long groupId,
                                                                                        long folderId,
                                                                                        boolean recurse)

getSubfolderIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<java.lang.Long> getSubfolderIds(long groupId,
                                                                                                                  long folderId,
                                                                                                                  boolean recurse)

moveFolder

JournalFolder moveFolder(long folderId,
                         long parentFolderId,
                         ServiceContext serviceContext)
                  throws PortalException

Throws:

PortalException

moveFolderFromTrash

JournalFolder moveFolderFromTrash(long folderId,
                                  long parentFolderId,
                                  ServiceContext serviceContext)
                           throws PortalException

Throws:

PortalException

moveFolderToTrash

JournalFolder moveFolderToTrash(long folderId)
                         throws PortalException

Throws:

PortalException

restoreFolderFromTrash

void restoreFolderFromTrash(long folderId)
                     throws PortalException

Throws:

PortalException

searchDDMStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMStructure> searchDDMStructures(long companyId,
                                                                                                                    long[] groupIds,
                                                                                                                    long folderId,
                                                                                                                    int restrictionType,
                                                                                                                    java.lang.String keywords,
                                                                                                                    int start,
                                                                                                                    int end,
                                                                                                                    OrderByComparator<DDMStructure> orderByComparator)
                                                                                                             throws PortalException

Throws:

PortalException

subscribe

void subscribe(long groupId,
               long folderId)
        throws PortalException

Throws:

PortalException

unsubscribe

void unsubscribe(long groupId,
                 long folderId)
          throws PortalException

Throws:

PortalException

updateFolder

JournalFolder updateFolder(long groupId,
                           long folderId,
                           long parentFolderId,
                           java.lang.String name,
                           java.lang.String description,
                           boolean mergeWithParentFolder,
                           ServiceContext serviceContext)
                    throws PortalException

Throws:

PortalException

updateFolder

JournalFolder updateFolder(long groupId,
                           long folderId,
                           long parentFolderId,
                           java.lang.String name,
                           java.lang.String description,
                           long[] ddmStructureIds,
                           int restrictionType,
                           boolean mergeWithParentFolder,
                           ServiceContext serviceContext)
                    throws PortalException

Throws:

PortalException