Class ImageLocalServiceUtil
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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic Image
Adds the image to the database.static Image
createImage
(long imageId) Creates a new image with the primary key.static PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static Image
deleteImage
(long imageId) Deletes the image with the primary key from the database.static Image
deleteImage
(Image image) Deletes the image from the database.static PersistedModel
deletePersistedModel
(PersistedModel persistedModel) static <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static 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
static Image
getCompanyLogo
(long imageId) static Image
getImage
(long imageId) Returns the image with the primary key.static InputStream
getImageInputStream
(long companyId, long imageId, String type) static Image
getImageOrDefault
(long imageId) getImages
(int start, int end) Returns a range of all the images.getImagesBySize
(int size) static int
Returns the number of images.static String
Returns the OSGi service identifier.static PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static ImageLocalService
static Image
moveImage
(long imageId, byte[] bytes) static void
setService
(ImageLocalService service) static Image
updateImage
(long imageId, byte[] bytes) Deprecated.static Image
updateImage
(long imageId, byte[] bytes, String type, int height, int width, int size) Deprecated.As of Cavanaugh (7.4.x), replaced byupdateImage(long, long, byte[], String, int, int, int)
static Image
updateImage
(long companyId, long imageId, byte[] bytes) static Image
updateImage
(long companyId, long imageId, byte[] bytes, String type, int height, int width, int size) static Image
updateImage
(long companyId, long imageId, File file) static Image
updateImage
(long companyId, long imageId, InputStream inputStream) static Image
updateImage
(long companyId, long imageId, InputStream inputStream, boolean cleanUpStream) static Image
updateImage
(long imageId, File file) Deprecated.As of Cavanaugh (7.4.x), replaced byupdateImage(long, long, File)
static Image
updateImage
(long imageId, InputStream inputStream) Deprecated.As of Cavanaugh (7.4.x), replaced byupdateImage(long, long, InputStream)
static Image
updateImage
(long imageId, InputStream inputStream, boolean cleanUpStream) Deprecated.As of Cavanaugh (7.4.x), replaced byupdateImage(long, long, InputStream, boolean)
static Image
updateImage
(Image image) Updates the image in the database or adds it if it does not yet exist.
-
Constructor Details
-
ImageLocalServiceUtil
public ImageLocalServiceUtil()
-
-
Method Details
-
addImage
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
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
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
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
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.ImageModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.ImageModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchImage
-
getActionableDynamicQuery
-
getCompanyLogo
-
getImage
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
-
getImages
-
getImages
Returns a range of all the images.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.ImageModelImpl
.- Parameters:
start
- the lower bound of the range of imagesend
- the upper bound of the range of images (not inclusive)- Returns:
- the range of images
-
getImagesBySize
-
getImagesCount
public static int getImagesCount()Returns the number of images.- Returns:
- the number of images
-
getIndexableActionableDynamicQuery
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
moveImage
- Throws:
PortalException
-
updateImage
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.As of Cavanaugh (7.4.x), replaced byupdateImage(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 byupdateImage(long, long, byte[], String, int, int, int)
- Throws:
PortalException
-
updateImage
Deprecated.As of Cavanaugh (7.4.x), replaced byupdateImage(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 byupdateImage(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 byupdateImage(long, long, InputStream, boolean)
- Throws:
PortalException
-
updateImage
- 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
- 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
-
setService
-
updateImage(long, long, byte[])