com.liferay.portal.kernel.service

Class ImageLocalServiceUtil

Object

com.liferay.portal.kernel.service.ImageLocalServiceUtil

@ProviderType
public class ImageLocalServiceUtil
extends Object

Provides the local service utility for Image. This utility wraps ImageLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. 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.

Author:

Brian Wing Shun Chan

See Also:

ImageLocalService, ImageLocalServiceBaseImpl, ImageLocalServiceImpl

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
ImageLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static Image	addImage(Image image) Adds the image to the database.
static Image	createImage(long imageId) Creates a new image with the primary key.
static Image	deleteImage(Image image) Deletes the image from the database.
static Image	deleteImage(long imageId) Deletes the image with the primary key from the database.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static DynamicQuery	dynamicQuery()
static <T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static <T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> 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 matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static Image	fetchImage(long imageId)
static ActionableDynamicQuery	getActionableDynamicQuery()
static Image	getCompanyLogo(long imageId)
static Image	getImage(long imageId) Returns the image with the primary key.
static Image	getImageOrDefault(long imageId)
static List<Image>	getImages()
static List<Image>	getImages(int start, int end) Returns a range of all the images.
static List<Image>	getImagesBySize(int size)
static int	getImagesCount() Returns the number of images.
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static ImageLocalService	getService()
static Image	moveImage(long imageId, byte[] bytes)
static Image	updateImage(Image image) Updates the image in the database or adds it if it does not yet exist.
static Image	updateImage(long imageId, byte[] bytes)
static Image	updateImage(long imageId, byte[] bytes, String type, int height, int width, int size)
static Image	updateImage(long imageId, File file)
static Image	updateImage(long imageId, InputStream is)
static Image	updateImage(long imageId, InputStream is, boolean cleanUpStream)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImageLocalServiceUtil

public ImageLocalServiceUtil()

Method Detail

addImage

public static Image addImage(Image image)

Adds the image to the database. Also notifies the appropriate model listeners.

Parameters:

image - the image

Returns:

the image that was added

createImage

public static Image createImage(long imageId)

Creates a new image with the primary key. Does not add the image to the database.

Parameters:

imageId - the primary key for the new image

Returns:

the new image

deleteImage

public static Image deleteImage(Image image)

Deletes the image from the database. Also notifies the appropriate model listeners.

Parameters:

image - the image

Returns:

the image that was removed

deleteImage

public static Image deleteImage(long imageId)
                         throws PortalException

Deletes the image with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

imageId - the primary key of the image

Returns:

the image that was removed

Throws:

PortalException - if a image with the primary key could not be found

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)

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

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                       int start,
                                       int end)

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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ImageModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                       int start,
                                       int end,
                                       OrderByComparator<T> orderByComparator)

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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ImageModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchImage

public static Image fetchImage(long imageId)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getCompanyLogo

public static Image getCompanyLogo(long imageId)

getImage

public static Image getImage(long imageId)
                      throws PortalException

Returns the image with the primary key.

Parameters:

imageId - the primary key of the image

Returns:

the image

Throws:

PortalException - if a image with the primary key could not be found

getImageOrDefault

public static Image getImageOrDefault(long imageId)

getImages

public static List<Image> getImages()

getImages

public static List<Image> getImages(int start,
                                    int end)

Returns a range of all the 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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ImageModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

start - the lower bound of the range of images

end - the upper bound of the range of images (not inclusive)

Returns:

the range of images

getImagesBySize

public static List<Image> getImagesBySize(int size)

getImagesCount

public static int getImagesCount()

Returns the number of images.

Returns:

the number of images

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

moveImage

public static Image moveImage(long imageId,
                              byte[] bytes)
                       throws PortalException

Throws:

PortalException

updateImage

public static Image updateImage(Image image)

Updates the image in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

image - the image

Returns:

the image that was updated

updateImage

public static Image updateImage(long imageId,
                                byte[] bytes)
                         throws PortalException

Throws:

PortalException

updateImage

public static Image updateImage(long imageId,
                                byte[] bytes,
                                String type,
                                int height,
                                int width,
                                int size)
                         throws PortalException

Throws:

PortalException

updateImage

public static Image updateImage(long imageId,
                                File file)
                         throws PortalException

Throws:

PortalException

updateImage

public static Image updateImage(long imageId,
                                InputStream is)
                         throws PortalException

Throws:

PortalException

updateImage

public static Image updateImage(long imageId,
                                InputStream is,
                                boolean cleanUpStream)
                         throws PortalException

Throws:

PortalException

getService

public static ImageLocalService getService()