Liferay 6.0-ee-sp2

com.liferay.portlet.imagegallery.service
Class IGFolderLocalServiceUtil

java.lang.Object
  extended by com.liferay.portlet.imagegallery.service.IGFolderLocalServiceUtil

public class IGFolderLocalServiceUtil
extends Object

The utility for the i g folder local service. This utility wraps com.liferay.portlet.imagegallery.service.impl.IGFolderLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

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:
IGFolderLocalService, com.liferay.portlet.imagegallery.service.base.IGFolderLocalServiceBaseImpl, com.liferay.portlet.imagegallery.service.impl.IGFolderLocalServiceImpl

Constructor Summary
IGFolderLocalServiceUtil()
           
 
Method Summary
static IGFolder addFolder(long userId, long parentFolderId, String name, String description, ServiceContext serviceContext)
           
static void addFolderResources(IGFolder folder, boolean addCommunityPermissions, boolean addGuestPermissions)
           
static void addFolderResources(IGFolder folder, String[] communityPermissions, String[] guestPermissions)
           
static void addFolderResources(long folderId, boolean addCommunityPermissions, boolean addGuestPermissions)
           
static void addFolderResources(long folderId, String[] communityPermissions, String[] guestPermissions)
           
static IGFolder addIGFolder(IGFolder igFolder)
          Adds the i g folder to the database.
static IGFolder createIGFolder(long folderId)
          Creates a new i g folder with the primary key.
static void deleteFolder(IGFolder folder)
           
static void deleteFolder(long folderId)
           
static void deleteFolders(long groupId)
           
static void deleteIGFolder(IGFolder igFolder)
          Deletes the i g folder from the database.
static void deleteIGFolder(long folderId)
          Deletes the i g folder with the primary key from the database.
static List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static 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.
static long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
static String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
static List<IGFolder> getCompanyFolders(long companyId, int start, int end)
           
static int getCompanyFoldersCount(long companyId)
           
static IGFolder getFolder(long folderId)
           
static IGFolder getFolder(long groupId, long parentFolderId, String name)
           
static List<IGFolder> getFolders(long groupId)
           
static List<IGFolder> getFolders(long groupId, long parentFolderId)
           
static List<IGFolder> getFolders(long groupId, long parentFolderId, int start, int end)
           
static int getFoldersCount(long groupId, long parentFolderId)
           
static IGFolder getIGFolder(long folderId)
          Returns the i g folder with the primary key.
static IGFolder getIGFolderByUuidAndGroupId(String uuid, long groupId)
          Returns the i g folder with the UUID in the group.
static List<IGFolder> getIGFolders(int start, int end)
          Returns a range of all the i g folders.
static int getIGFoldersCount()
          Returns the number of i g folders.
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static IGFolderLocalService getService()
           
static void getSubfolderIds(List<Long> folderIds, long groupId, long folderId)
           
static void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setService(IGFolderLocalService service)
           
static IGFolder updateFolder(long folderId, long parentFolderId, String name, String description, boolean mergeWithParentFolder, ServiceContext serviceContext)
           
static IGFolder updateIGFolder(IGFolder igFolder)
          Updates the i g folder in the database or adds it if it does not yet exist.
static IGFolder updateIGFolder(IGFolder igFolder, boolean merge)
          Updates the i g folder in the database or adds it if it does not yet exist.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IGFolderLocalServiceUtil

public IGFolderLocalServiceUtil()
Method Detail

addIGFolder

public static 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
Returns:
the i g folder that was added
Throws:
SystemException - if a system exception occurred

createIGFolder

public static 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

public static 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
Throws:
PortalException - if a i g folder with the primary key could not be found
SystemException - if a system exception occurred

deleteIGFolder

public static 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
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static 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
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
Returns:
the range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static 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
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

getIGFolder

public static IGFolder getIGFolder(long folderId)
                            throws PortalException,
                                   SystemException
Returns the i g folder with the primary key.

Parameters:
folderId - the primary key of the i g folder
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

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException
Throws:
PortalException
SystemException

getIGFolderByUuidAndGroupId

public static IGFolder getIGFolderByUuidAndGroupId(String uuid,
                                                   long groupId)
                                            throws PortalException,
                                                   SystemException
Returns the i g folder with the UUID in the group.

Parameters:
uuid - the UUID of i g folder
groupId - the group id of the i g folder
Returns:
the i g folder
Throws:
PortalException - if a i g folder with the UUID in the group could not be found
SystemException - if a system exception occurred

getIGFolders

public static List<IGFolder> getIGFolders(int start,
                                          int end)
                                   throws SystemException
Returns 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
end - the upper bound of the range of i g folders (not inclusive)
Returns:
the range of i g folders
Throws:
SystemException - if a system exception occurred

getIGFoldersCount

public static int getIGFoldersCount()
                             throws SystemException
Returns the number of i g folders.

Returns:
the number of i g folders
Throws:
SystemException - if a system exception occurred

updateIGFolder

public static IGFolder updateIGFolder(IGFolder igFolder)
                               throws SystemException
Updates the i g folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
igFolder - the i g folder
Returns:
the i g folder that was updated
Throws:
SystemException - if a system exception occurred

updateIGFolder

public static IGFolder updateIGFolder(IGFolder igFolder,
                                      boolean merge)
                               throws SystemException
Updates the i g folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
igFolder - the i g folder
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

getBeanIdentifier

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

Returns:
the Spring bean ID for this bean

setBeanIdentifier

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

Parameters:
beanIdentifier - the Spring bean ID for this bean

addFolder

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

addFolderResources

public static void addFolderResources(IGFolder folder,
                                      boolean addCommunityPermissions,
                                      boolean addGuestPermissions)
                               throws PortalException,
                                      SystemException
Throws:
PortalException
SystemException

addFolderResources

public static void addFolderResources(IGFolder folder,
                                      String[] communityPermissions,
                                      String[] guestPermissions)
                               throws PortalException,
                                      SystemException
Throws:
PortalException
SystemException

addFolderResources

public static void addFolderResources(long folderId,
                                      boolean addCommunityPermissions,
                                      boolean addGuestPermissions)
                               throws PortalException,
                                      SystemException
Throws:
PortalException
SystemException

addFolderResources

public static void addFolderResources(long folderId,
                                      String[] communityPermissions,
                                      String[] guestPermissions)
                               throws PortalException,
                                      SystemException
Throws:
PortalException
SystemException

deleteFolder

public static void deleteFolder(IGFolder folder)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

deleteFolder

public static void deleteFolder(long folderId)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

deleteFolders

public static void deleteFolders(long groupId)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

getCompanyFolders

public static List<IGFolder> getCompanyFolders(long companyId,
                                               int start,
                                               int end)
                                        throws SystemException
Throws:
SystemException

getCompanyFoldersCount

public static int getCompanyFoldersCount(long companyId)
                                  throws SystemException
Throws:
SystemException

getFolder

public static IGFolder getFolder(long folderId)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

getFolder

public static IGFolder getFolder(long groupId,
                                 long parentFolderId,
                                 String name)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

getFolders

public static List<IGFolder> getFolders(long groupId)
                                 throws SystemException
Throws:
SystemException

getFolders

public static List<IGFolder> getFolders(long groupId,
                                        long parentFolderId)
                                 throws SystemException
Throws:
SystemException

getFolders

public static List<IGFolder> getFolders(long groupId,
                                        long parentFolderId,
                                        int start,
                                        int end)
                                 throws SystemException
Throws:
SystemException

getFoldersCount

public static int getFoldersCount(long groupId,
                                  long parentFolderId)
                           throws SystemException
Throws:
SystemException

getSubfolderIds

public static void getSubfolderIds(List<Long> folderIds,
                                   long groupId,
                                   long folderId)
                            throws SystemException
Throws:
SystemException

updateFolder

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

getService

public static IGFolderLocalService getService()

setService

public void setService(IGFolderLocalService service)

Liferay 6.0-ee-sp2