Class ImageLocalServiceUtil

Object
com.liferay.portal.kernel.service.ImageLocalServiceUtil

public class ImageLocalServiceUtil extends Object
Provides the local service utility for Image. This utility wraps com.liferay.portal.service.impl.ImageLocalServiceImpl and is an 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:
{$generated.description}
  • Constructor Details

    • ImageLocalServiceUtil

      public ImageLocalServiceUtil()
  • Method Details

    • addImage

      public static Image addImage(Image image)
      Adds the image to the database. Also notifies the appropriate model listeners.

      Important: Inspect ImageLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      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
    • createPersistedModel

      public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • deleteImage

      public static Image deleteImage(Image image)
      Deletes the image from the database. Also notifies the appropriate model listeners.

      Important: Inspect ImageLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      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.

      Important: Inspect ImageLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      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
    • dslQuery

      public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dslQueryCount

      public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.ImageModelImpl.

      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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.ImageModelImpl.

      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
    • getImageInputStream

      public static InputStream getImageInputStream(long companyId, long imageId, String type) throws PortalException
      Throws:
      PortalException
    • 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.ImageModelImpl.

      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.

      Important: Inspect ImageLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      image - the image
      Returns:
      the image that was updated
    • updateImage

      @Deprecated public static Image updateImage(long imageId, byte[] bytes) throws PortalException
      Deprecated.
      As of Cavanaugh (7.4.x), replaced by updateImage(long, long, byte[])
      Throws:
      PortalException
    • updateImage

      @Deprecated public static Image updateImage(long imageId, byte[] bytes, String type, int height, int width, int size) throws PortalException
      Deprecated.
      As of Cavanaugh (7.4.x), replaced by updateImage(long, long, byte[], String, int, int, int)
      Throws:
      PortalException
    • updateImage

      @Deprecated public static Image updateImage(long imageId, File file) throws PortalException
      Deprecated.
      As of Cavanaugh (7.4.x), replaced by updateImage(long, long, File)
      Throws:
      PortalException
    • updateImage

      @Deprecated public static Image updateImage(long imageId, InputStream inputStream) throws PortalException
      Deprecated.
      As of Cavanaugh (7.4.x), replaced by updateImage(long, long, InputStream)
      Throws:
      PortalException
    • updateImage

      @Deprecated public static Image updateImage(long imageId, InputStream inputStream, boolean cleanUpStream) throws PortalException
      Deprecated.
      As of Cavanaugh (7.4.x), replaced by updateImage(long, long, InputStream, boolean)
      Throws:
      PortalException
    • updateImage

      public static Image updateImage(long companyId, long imageId, byte[] bytes) throws PortalException
      Throws:
      PortalException
    • updateImage

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

      public static Image updateImage(long companyId, long imageId, File file) throws PortalException
      Throws:
      PortalException
    • updateImage

      public static Image updateImage(long companyId, long imageId, InputStream inputStream) throws PortalException
      Throws:
      PortalException
    • updateImage

      public static Image updateImage(long companyId, long imageId, InputStream inputStream, boolean cleanUpStream) throws PortalException
      Throws:
      PortalException
    • getService

      public static ImageLocalService getService()
    • setService

      public static void setService(ImageLocalService service)