Liferay 7.0-ce-m6

com.liferay.portlet.journal.service
Interface JournalFolderService

All Superinterfaces:
BaseService
All Known Implementing Classes:
JournalFolderServiceBaseImpl, JournalFolderServiceImpl, 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, JournalFolderServiceBaseImpl, JournalFolderServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 JournalFolder addFolder(long groupId, long parentFolderId, String name, String description, ServiceContext serviceContext)
           
 void deleteFolder(long folderId)
           
 void deleteFolder(long folderId, boolean includeTrashedEntries)
           
 JournalFolder fetchFolder(long folderId)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 List<DDMStructure> getDDMStructures(long[] groupIds, long folderId, int restrictionType)
           
 JournalFolder getFolder(long folderId)
           
 List<Long> getFolderIds(long groupId, long folderId)
           
 List<JournalFolder> getFolders(long groupId)
           
 List<JournalFolder> getFolders(long groupId, long parentFolderId)
           
 List<JournalFolder> getFolders(long groupId, long parentFolderId, int status)
           
 List<JournalFolder> getFolders(long groupId, long parentFolderId, int start, int end)
           
 List<JournalFolder> getFolders(long groupId, long parentFolderId, int status, int start, int end)
           
 List<Object> getFoldersAndArticles(long groupId, long folderId, int status, int start, int end, OrderByComparator<?> obc)
           
 List<Object> getFoldersAndArticles(long groupId, long folderId, int start, int end, OrderByComparator<?> obc)
           
 int getFoldersAndArticlesCount(long groupId, List<Long> folderIds, int status)
           
 int getFoldersAndArticlesCount(long groupId, long folderId)
           
 int getFoldersAndArticlesCount(long groupId, long folderId, int status)
           
 int getFoldersCount(long groupId, long parentFolderId)
           
 int getFoldersCount(long groupId, long parentFolderId, int status)
           
 void getSubfolderIds(List<Long> folderIds, long groupId, long folderId)
          Deprecated. As of 7.0.0, replaced by getSubfolderIds(List, long, long, boolean)
 void getSubfolderIds(List<Long> folderIds, long groupId, long folderId, boolean recurse)
           
 List<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)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void subscribe(long groupId, long folderId)
           
 void unsubscribe(long groupId, long folderId)
           
 JournalFolder updateFolder(long groupId, long folderId, long parentFolderId, String name, String description, boolean mergeWithParentFolder, ServiceContext serviceContext)
           
 JournalFolder updateFolder(long groupId, long folderId, long parentFolderId, String name, String description, long[] ddmStructureIds, int restrictionType, boolean mergeWithParentFolder, ServiceContext serviceContext)
           
 

Method Detail

addFolder

JournalFolder addFolder(long groupId,
                        long parentFolderId,
                        String name,
                        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

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

getDDMStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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)
List<Long> getFolderIds(long groupId,
                                                                 long folderId)
                        throws PortalException
Throws:
PortalException

getFolders

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

getFolders

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

getFolders

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

getFolders

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

getFolders

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

getFoldersAndArticles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Object> getFoldersAndArticles(long groupId,
                                                                            long folderId,
                                                                            int start,
                                                                            int end,
                                                                            OrderByComparator<?> obc)

getFoldersAndArticles

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

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,
                                                                        List<Long> folderIds,
                                                                        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)

getSubfolderIds

@Deprecated
@Transactional(propagation=SUPPORTS,
               readOnly=true)
void getSubfolderIds(List<Long> folderIds,
                                                                         long groupId,
                                                                         long folderId)
Deprecated. As of 7.0.0, replaced by getSubfolderIds(List, long, long, boolean)


getSubfolderIds

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

getSubfolderIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<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

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

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,
                           String name,
                           String description,
                           long[] ddmStructureIds,
                           int restrictionType,
                           boolean mergeWithParentFolder,
                           ServiceContext serviceContext)
                           throws PortalException
Throws:
PortalException

updateFolder

JournalFolder updateFolder(long groupId,
                           long folderId,
                           long parentFolderId,
                           String name,
                           String description,
                           boolean mergeWithParentFolder,
                           ServiceContext serviceContext)
                           throws PortalException
Throws:
PortalException

Liferay 7.0-ce-m6