Liferay 6.0-ee-sp2

com.liferay.portlet.imagegallery.service
Class IGImageLocalServiceUtil

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

public class IGImageLocalServiceUtil
extends Object

The utility for the i g image local service. This utility wraps com.liferay.portlet.imagegallery.service.impl.IGImageLocalServiceImpl 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:
IGImageLocalService, com.liferay.portlet.imagegallery.service.base.IGImageLocalServiceBaseImpl, com.liferay.portlet.imagegallery.service.impl.IGImageLocalServiceImpl

Constructor Summary
IGImageLocalServiceUtil()
           
 
Method Summary
static IGImage addIGImage(IGImage igImage)
          Adds the i g image to the database.
static IGImage addImage(long userId, long groupId, long folderId, String name, String description, File file, String contentType, ServiceContext serviceContext)
           
static IGImage addImage(long userId, long groupId, long folderId, String name, String description, String fileName, byte[] bytes, String contentType, ServiceContext serviceContext)
           
static IGImage addImage(long userId, long groupId, long folderId, String name, String description, String fileName, InputStream is, String contentType, ServiceContext serviceContext)
           
static void addImageResources(IGImage image, boolean addCommunityPermissions, boolean addGuestPermissions)
           
static void addImageResources(IGImage image, String[] communityPermissions, String[] guestPermissions)
           
static void addImageResources(long imageId, boolean addCommunityPermissions, boolean addGuestPermissions)
           
static void addImageResources(long imageId, String[] communityPermissions, String[] guestPermissions)
           
static IGImage createIGImage(long imageId)
          Creates a new i g image with the primary key.
static void deleteIGImage(IGImage igImage)
          Deletes the i g image from the database.
static void deleteIGImage(long imageId)
          Deletes the i g image with the primary key from the database.
static void deleteImage(IGImage image)
           
static void deleteImage(long imageId)
           
static void deleteImages(long groupId, long folderId)
           
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 int getFoldersImagesCount(long groupId, List<Long> folderIds)
           
static List<IGImage> getGroupImages(long groupId, int start, int end)
           
static List<IGImage> getGroupImages(long groupId, long userId, int start, int end)
           
static int getGroupImagesCount(long groupId)
           
static int getGroupImagesCount(long groupId, long userId)
           
static IGImage getIGImage(long imageId)
          Returns the i g image with the primary key.
static IGImage getIGImageByUuidAndGroupId(String uuid, long groupId)
          Returns the i g image with the UUID in the group.
static List<IGImage> getIGImages(int start, int end)
          Returns a range of all the i g images.
static int getIGImagesCount()
          Returns the number of i g images.
static IGImage getImage(long imageId)
           
static IGImage getImageByCustom1ImageId(long custom1ImageId)
           
static IGImage getImageByCustom2ImageId(long custom2ImageId)
           
static IGImage getImageByFolderIdAndNameWithExtension(long groupId, long folderId, String nameWithExtension)
           
static IGImage getImageByLargeImageId(long largeImageId)
           
static IGImage getImageBySmallImageId(long smallImageId)
           
static IGImage getImageByUuidAndGroupId(String uuid, long groupId)
           
static List<IGImage> getImages(long groupId, long folderId)
           
static List<IGImage> getImages(long groupId, long folderId, int start, int end)
           
static List<IGImage> getImages(long groupId, long folderId, int start, int end, OrderByComparator obc)
           
static int getImagesCount(long groupId, long folderId)
           
static List<IGImage> getNoAssetImages()
           
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static IGImageLocalService getService()
           
static void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setService(IGImageLocalService service)
           
static void updateAsset(long userId, IGImage image, long[] assetCategoryIds, String[] assetTagNames, String contentType)
           
static IGImage updateIGImage(IGImage igImage)
          Updates the i g image in the database or adds it if it does not yet exist.
static IGImage updateIGImage(IGImage igImage, boolean merge)
          Updates the i g image in the database or adds it if it does not yet exist.
static IGImage updateImage(long userId, long imageId, long groupId, long folderId, String name, String description, byte[] bytes, String contentType, ServiceContext serviceContext)
           
static IGImage updateImage(long userId, long imageId, long groupId, long folderId, String name, String description, File file, String contentType, ServiceContext serviceContext)
           
static IGImage updateImage(long userId, long imageId, long groupId, long folderId, String name, String description, InputStream is, String contentType, ServiceContext serviceContext)
           
static void updateSmallImage(long smallImageId, long largeImageId)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IGImageLocalServiceUtil

public IGImageLocalServiceUtil()
Method Detail

addIGImage

public static IGImage addIGImage(IGImage igImage)
                          throws SystemException
Adds the i g image to the database. Also notifies the appropriate model listeners.

Parameters:
igImage - the i g image
Returns:
the i g image that was added
Throws:
SystemException - if a system exception occurred

createIGImage

public static IGImage createIGImage(long imageId)
Creates a new i g image with the primary key. Does not add the i g image to the database.

Parameters:
imageId - the primary key for the new i g image
Returns:
the new i g image

deleteIGImage

public static void deleteIGImage(long imageId)
                          throws PortalException,
                                 SystemException
Deletes the i g image with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
imageId - the primary key of the i g image
Throws:
PortalException - if a i g image with the primary key could not be found
SystemException - if a system exception occurred

deleteIGImage

public static void deleteIGImage(IGImage igImage)
                          throws SystemException
Deletes the i g image from the database. Also notifies the appropriate model listeners.

Parameters:
igImage - the i g image
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

getIGImage

public static IGImage getIGImage(long imageId)
                          throws PortalException,
                                 SystemException
Returns the i g image with the primary key.

Parameters:
imageId - the primary key of the i g image
Returns:
the i g image
Throws:
PortalException - if a i g image 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

getIGImageByUuidAndGroupId

public static IGImage getIGImageByUuidAndGroupId(String uuid,
                                                 long groupId)
                                          throws PortalException,
                                                 SystemException
Returns the i g image with the UUID in the group.

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

getIGImages

public static List<IGImage> getIGImages(int start,
                                        int end)
                                 throws SystemException
Returns a range of all the i g images.

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 images
end - the upper bound of the range of i g images (not inclusive)
Returns:
the range of i g images
Throws:
SystemException - if a system exception occurred

getIGImagesCount

public static int getIGImagesCount()
                            throws SystemException
Returns the number of i g images.

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

updateIGImage

public static IGImage updateIGImage(IGImage igImage)
                             throws SystemException
Updates the i g image in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

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

updateIGImage

public static IGImage updateIGImage(IGImage igImage,
                                    boolean merge)
                             throws SystemException
Updates the i g image in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
igImage - the i g image
merge - whether to merge the i g image 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 image 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

addImage

public static IGImage addImage(long userId,
                               long groupId,
                               long folderId,
                               String name,
                               String description,
                               File file,
                               String contentType,
                               ServiceContext serviceContext)
                        throws PortalException,
                               SystemException
Throws:
PortalException
SystemException

addImage

public static IGImage addImage(long userId,
                               long groupId,
                               long folderId,
                               String name,
                               String description,
                               String fileName,
                               byte[] bytes,
                               String contentType,
                               ServiceContext serviceContext)
                        throws PortalException,
                               SystemException
Throws:
PortalException
SystemException

addImage

public static IGImage addImage(long userId,
                               long groupId,
                               long folderId,
                               String name,
                               String description,
                               String fileName,
                               InputStream is,
                               String contentType,
                               ServiceContext serviceContext)
                        throws PortalException,
                               SystemException
Throws:
PortalException
SystemException

addImageResources

public static void addImageResources(IGImage image,
                                     boolean addCommunityPermissions,
                                     boolean addGuestPermissions)
                              throws PortalException,
                                     SystemException
Throws:
PortalException
SystemException

addImageResources

public static void addImageResources(IGImage image,
                                     String[] communityPermissions,
                                     String[] guestPermissions)
                              throws PortalException,
                                     SystemException
Throws:
PortalException
SystemException

addImageResources

public static void addImageResources(long imageId,
                                     boolean addCommunityPermissions,
                                     boolean addGuestPermissions)
                              throws PortalException,
                                     SystemException
Throws:
PortalException
SystemException

addImageResources

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

deleteImage

public static void deleteImage(IGImage image)
                        throws PortalException,
                               SystemException
Throws:
PortalException
SystemException

deleteImage

public static void deleteImage(long imageId)
                        throws PortalException,
                               SystemException
Throws:
PortalException
SystemException

deleteImages

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

getFoldersImagesCount

public static int getFoldersImagesCount(long groupId,
                                        List<Long> folderIds)
                                 throws SystemException
Throws:
SystemException

getGroupImages

public static List<IGImage> getGroupImages(long groupId,
                                           int start,
                                           int end)
                                    throws SystemException
Throws:
SystemException

getGroupImages

public static List<IGImage> getGroupImages(long groupId,
                                           long userId,
                                           int start,
                                           int end)
                                    throws SystemException
Throws:
SystemException

getGroupImagesCount

public static int getGroupImagesCount(long groupId)
                               throws SystemException
Throws:
SystemException

getGroupImagesCount

public static int getGroupImagesCount(long groupId,
                                      long userId)
                               throws SystemException
Throws:
SystemException

getImage

public static IGImage getImage(long imageId)
                        throws PortalException,
                               SystemException
Throws:
PortalException
SystemException

getImageByCustom1ImageId

public static IGImage getImageByCustom1ImageId(long custom1ImageId)
                                        throws PortalException,
                                               SystemException
Throws:
PortalException
SystemException

getImageByCustom2ImageId

public static IGImage getImageByCustom2ImageId(long custom2ImageId)
                                        throws PortalException,
                                               SystemException
Throws:
PortalException
SystemException

getImageByFolderIdAndNameWithExtension

public static IGImage getImageByFolderIdAndNameWithExtension(long groupId,
                                                             long folderId,
                                                             String nameWithExtension)
                                                      throws PortalException,
                                                             SystemException
Throws:
PortalException
SystemException

getImageByLargeImageId

public static IGImage getImageByLargeImageId(long largeImageId)
                                      throws PortalException,
                                             SystemException
Throws:
PortalException
SystemException

getImageBySmallImageId

public static IGImage getImageBySmallImageId(long smallImageId)
                                      throws PortalException,
                                             SystemException
Throws:
PortalException
SystemException

getImageByUuidAndGroupId

public static IGImage getImageByUuidAndGroupId(String uuid,
                                               long groupId)
                                        throws PortalException,
                                               SystemException
Throws:
PortalException
SystemException

getImages

public static List<IGImage> getImages(long groupId,
                                      long folderId)
                               throws SystemException
Throws:
SystemException

getImages

public static List<IGImage> getImages(long groupId,
                                      long folderId,
                                      int start,
                                      int end)
                               throws SystemException
Throws:
SystemException

getImages

public static List<IGImage> getImages(long groupId,
                                      long folderId,
                                      int start,
                                      int end,
                                      OrderByComparator obc)
                               throws SystemException
Throws:
SystemException

getImagesCount

public static int getImagesCount(long groupId,
                                 long folderId)
                          throws SystemException
Throws:
SystemException

getNoAssetImages

public static List<IGImage> getNoAssetImages()
                                      throws SystemException
Throws:
SystemException

updateAsset

public static void updateAsset(long userId,
                               IGImage image,
                               long[] assetCategoryIds,
                               String[] assetTagNames,
                               String contentType)
                        throws PortalException,
                               SystemException
Throws:
PortalException
SystemException

updateImage

public static IGImage updateImage(long userId,
                                  long imageId,
                                  long groupId,
                                  long folderId,
                                  String name,
                                  String description,
                                  byte[] bytes,
                                  String contentType,
                                  ServiceContext serviceContext)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

updateImage

public static IGImage updateImage(long userId,
                                  long imageId,
                                  long groupId,
                                  long folderId,
                                  String name,
                                  String description,
                                  File file,
                                  String contentType,
                                  ServiceContext serviceContext)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

updateImage

public static IGImage updateImage(long userId,
                                  long imageId,
                                  long groupId,
                                  long folderId,
                                  String name,
                                  String description,
                                  InputStream is,
                                  String contentType,
                                  ServiceContext serviceContext)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

updateSmallImage

public static void updateSmallImage(long smallImageId,
                                    long largeImageId)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

getService

public static IGImageLocalService getService()

setService

public void setService(IGImageLocalService service)

Liferay 6.0-ee-sp2