com.liferay.portlet.imagegallery.service
Interface IGFolderLocalService

All Known Implementing Classes:

IGFolderLocalServiceBaseImpl, IGFolderLocalServiceImpl, IGFolderLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface IGFolderLocalService

The interface for the i g folder local service.

Never modify or reference this interface directly. Always use IGFolderLocalServiceUtil to access the i g folder local service. Add custom service methods to IGFolderLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:

IGFolderLocalServiceUtil, IGFolderLocalServiceBaseImpl, IGFolderLocalServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary

IGFolder	addFolder(long userId, long parentFolderId, String name, String description, ServiceContext serviceContext)
void	addFolderResources(IGFolder folder, boolean addCommunityPermissions, boolean addGuestPermissions)
void	addFolderResources(IGFolder folder, String[] communityPermissions, String[] guestPermissions)
void	addFolderResources(long folderId, boolean addCommunityPermissions, boolean addGuestPermissions)
void	addFolderResources(long folderId, String[] communityPermissions, String[] guestPermissions)
IGFolder	addIGFolder(IGFolder igFolder) Adds the i g folder to the database.
IGFolder	createIGFolder(long folderId) Creates a new i g folder with the primary key.
void	deleteFolder(IGFolder folder)
void	deleteFolder(long folderId)
void	deleteFolders(long groupId)
void	deleteIGFolder(IGFolder igFolder) Deletes the i g folder from the database.
void	deleteIGFolder(long folderId) Deletes the i g folder with the primary key from the database.
List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Counts the number of rows that match the dynamic query.
List<IGFolder>	getCompanyFolders(long companyId, int start, int end)
int	getCompanyFoldersCount(long companyId)
IGFolder	getFolder(long folderId)
IGFolder	getFolder(long groupId, long parentFolderId, String name)
List<IGFolder>	getFolders(long groupId)
List<IGFolder>	getFolders(long groupId, long parentFolderId)
List<IGFolder>	getFolders(long groupId, long parentFolderId, int start, int end)
int	getFoldersCount(long groupId, long parentFolderId)
IGFolder	getIGFolder(long folderId) Gets the i g folder with the primary key.
IGFolder	getIGFolderByUuidAndGroupId(String uuid, long groupId) Gets the i g folder with the UUID and group id.
List<IGFolder>	getIGFolders(int start, int end) Gets a range of all the i g folders.
int	getIGFoldersCount() Gets the number of i g folders.
void	getSubfolderIds(List<Long> folderIds, long groupId, long folderId)
IGFolder	updateFolder(long folderId, long parentFolderId, String name, String description, boolean mergeWithParentFolder, ServiceContext serviceContext)
IGFolder	updateIGFolder(IGFolder igFolder) Updates the i g folder in the database.
IGFolder	updateIGFolder(IGFolder igFolder, boolean merge) Updates the i g folder in the database.

Method Detail

addIGFolder

IGFolder addIGFolder(IGFolder igFolder)
                     throws SystemException

Adds the i g folder to the database. Also notifies the appropriate model listeners.

Parameters:

igFolder - the i g folder to add

Returns:

the i g folder that was added

Throws:

SystemException - if a system exception occurred

createIGFolder

IGFolder createIGFolder(long folderId)

Creates a new i g folder with the primary key. Does not add the i g folder to the database.

Parameters:

folderId - the primary key for the new i g folder

Returns:

the new i g folder

deleteIGFolder

void deleteIGFolder(long folderId)
                    throws PortalException,
                           SystemException

Deletes the i g folder with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

folderId - the primary key of the i g folder to delete

Throws:

PortalException - if a i g folder with the primary key could not be found

SystemException - if a system exception occurred

deleteIGFolder

void deleteIGFolder(IGFolder igFolder)
                    throws SystemException

Deletes the i g folder from the database. Also notifies the appropriate model listeners.

Parameters:

igFolder - the i g folder to delete

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException

Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

dynamicQuery - the dynamic query to search with

start - the lower bound of the range of model instances to return

end - the upper bound of the range of model instances to return (not inclusive)

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException

Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

dynamicQuery - the dynamic query to search with

start - the lower bound of the range of model instances to return

end - the upper bound of the range of model instances to return (not inclusive)

orderByComparator - the comparator to order the results by

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Counts the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

getIGFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IGFolder getIGFolder(long folderId)
                     throws PortalException,
                            SystemException

Gets the i g folder with the primary key.

Parameters:

folderId - the primary key of the i g folder to get

Returns:

the i g folder

Throws:

PortalException - if a i g folder with the primary key could not be found

SystemException - if a system exception occurred

getIGFolderByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IGFolder getIGFolderByUuidAndGroupId(String uuid,
                                                                              long groupId)
                                     throws PortalException,
                                            SystemException

Gets the i g folder with the UUID and group id.

Parameters:

uuid - the UUID of i g folder to get

groupId - the group id of the i g folder to get

Returns:

the i g folder

Throws:

PortalException - if a i g folder with the UUID and group id could not be found

SystemException - if a system exception occurred

getIGFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<IGFolder> getIGFolders(int start,
                                                                     int end)
                            throws SystemException

Gets a range of all the i g folders.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

start - the lower bound of the range of i g folders to return

end - the upper bound of the range of i g folders to return (not inclusive)

Returns:

the range of i g folders

Throws:

SystemException - if a system exception occurred

getIGFoldersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getIGFoldersCount()
                      throws SystemException

Gets the number of i g folders.

Returns:

the number of i g folders

Throws:

SystemException - if a system exception occurred

updateIGFolder

IGFolder updateIGFolder(IGFolder igFolder)
                        throws SystemException

Updates the i g folder in the database. Also notifies the appropriate model listeners.

Parameters:

igFolder - the i g folder to update

Returns:

the i g folder that was updated

Throws:

SystemException - if a system exception occurred

updateIGFolder

IGFolder updateIGFolder(IGFolder igFolder,
                        boolean merge)
                        throws SystemException

Updates the i g folder in the database. Also notifies the appropriate model listeners.

Parameters:

igFolder - the i g folder to update

merge - whether to merge the i g folder with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the i g folder that was updated

Throws:

SystemException - if a system exception occurred

addFolder

IGFolder addFolder(long userId,
                   long parentFolderId,
                   String name,
                   String description,
                   ServiceContext serviceContext)
                   throws PortalException,
                          SystemException

Throws:

PortalException

SystemException

addFolderResources

void addFolderResources(IGFolder folder,
                        boolean addCommunityPermissions,
                        boolean addGuestPermissions)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

addFolderResources

void addFolderResources(IGFolder folder,
                        String[] communityPermissions,
                        String[] guestPermissions)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

addFolderResources

void addFolderResources(long folderId,
                        boolean addCommunityPermissions,
                        boolean addGuestPermissions)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

addFolderResources

void addFolderResources(long folderId,
                        String[] communityPermissions,
                        String[] guestPermissions)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

deleteFolder

void deleteFolder(IGFolder folder)
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException

deleteFolder

void deleteFolder(long folderId)
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException

deleteFolders

void deleteFolders(long groupId)
                   throws PortalException,
                          SystemException

Throws:

PortalException

SystemException

getCompanyFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<IGFolder> getCompanyFolders(long companyId,
                                                                          int start,
                                                                          int end)
                                 throws SystemException

Throws:

SystemException

getCompanyFoldersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCompanyFoldersCount(long companyId)
                           throws SystemException

Throws:

SystemException

getFolder

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

Throws:

PortalException

SystemException

getFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IGFolder getFolder(long groupId,
                                                            long parentFolderId,
                                                            String name)
                   throws PortalException,
                          SystemException

Throws:

PortalException

SystemException

getFolders

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

Throws:

SystemException

getFolders

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

Throws:

SystemException

getFolders

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

Throws:

SystemException

getFoldersCount

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

Throws:

SystemException

getSubfolderIds

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

Throws:

SystemException

updateFolder

IGFolder updateFolder(long folderId,
                      long parentFolderId,
                      String name,
                      String description,
                      boolean mergeWithParentFolder,
                      ServiceContext serviceContext)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException