com.liferay.adaptive.media.image.service

Class AMImageEntryLocalServiceUtil

java.lang.Object

com.liferay.adaptive.media.image.service.AMImageEntryLocalServiceUtil

public class AMImageEntryLocalServiceUtil
extends java.lang.Object

Provides the local service utility for AMImageEntry. This utility wraps com.liferay.adaptive.media.image.service.impl.AMImageEntryLocalServiceImpl 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.

See Also:

AMImageEntryLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
AMImageEntryLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static AMImageEntry	addAMImageEntry(AMImageConfigurationEntry amImageConfigurationEntry, com.liferay.portal.kernel.repository.model.FileVersion fileVersion, int height, int width, java.io.InputStream inputStream, long size) Adds an adaptive media image entry in the database and stores the image bytes in the file store.
static AMImageEntry	addAMImageEntry(AMImageEntry amImageEntry) Adds the am image entry to the database.
static AMImageEntry	createAMImageEntry(long amImageEntryId) Creates a new am image entry with the primary key.
static com.liferay.portal.kernel.model.PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
static void	deleteAMImageEntries(long companyId, AMImageConfigurationEntry amImageConfigurationEntry) Deletes all the adaptive media images generated for the configuration in the company.
static AMImageEntry	deleteAMImageEntry(AMImageEntry amImageEntry) Deletes the am image entry from the database.
static AMImageEntry	deleteAMImageEntry(long amImageEntryId) Deletes the am image entry with the primary key from the database.
static void	deleteAMImageEntryFileVersion(com.liferay.portal.kernel.repository.model.FileVersion fileVersion) Deletes all the adaptive media images generated for a file version.
static void	deleteAMImageEntryFileVersion(java.lang.String configurationUuid, long fileVersionId) Deletes adaptive media images generated for a file version under a given configuration.
static com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
static <T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.
static AMImageEntry	fetchAMImageEntry(long amImageEntryId)
static AMImageEntry	fetchAMImageEntry(java.lang.String configurationUuid, long fileVersionId) Returns the adaptive media image entry generated for the configuration and file version.
static AMImageEntry	fetchAMImageEntryByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the am image entry matching the UUID and group.
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
static java.util.List<AMImageEntry>	getAMImageEntries(int start, int end) Returns a range of all the am image entries.
static java.util.List<AMImageEntry>	getAMImageEntries(long fileVersionId) Returns the list of adaptive media image entries generated for the file version.
static java.util.List<AMImageEntry>	getAMImageEntriesByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns all the am image entries matching the UUID and company.
static java.util.List<AMImageEntry>	getAMImageEntriesByUuidAndCompanyId(java.lang.String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<AMImageEntry> orderByComparator) Returns a range of am image entries matching the UUID and company.
static int	getAMImageEntriesCount() Returns the number of am image entries.
static int	getAMImageEntriesCount(long companyId, java.lang.String configurationUuid) Returns the number of adaptive media image entries generated for the configuration in the company.
static AMImageEntry	getAMImageEntry(long amImageEntryId) Returns the am image entry with the primary key.
static AMImageEntry	getAMImageEntryByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the am image entry matching the UUID and group.
static java.io.InputStream	getAMImageEntryContentStream(AMImageConfigurationEntry amImageConfigurationEntry, com.liferay.portal.kernel.repository.model.FileVersion fileVersion) Returns the input stream of the adaptive media image generated for a file version and configuration.
static int	getExpectedAMImageEntriesCount(long companyId) Returns the total number of adaptive media images that are expected to be in a company once they are generated.
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static int	getPercentage(long companyId, java.lang.String configurationUuid) Returns the percentage of images that have an adaptive media image generated based on the expected number of adaptive media images for a configuration in a company.
static com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static AMImageEntryLocalService	getService()
static AMImageEntry	updateAMImageEntry(AMImageEntry amImageEntry) Updates the am image entry 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

AMImageEntryLocalServiceUtil

public AMImageEntryLocalServiceUtil()

Method Detail

addAMImageEntry

public static AMImageEntry addAMImageEntry(AMImageConfigurationEntry amImageConfigurationEntry,
                                           com.liferay.portal.kernel.repository.model.FileVersion fileVersion,
                                           int height,
                                           int width,
                                           java.io.InputStream inputStream,
                                           long size)
                                    throws com.liferay.portal.kernel.exception.PortalException

Adds an adaptive media image entry in the database and stores the image bytes in the file store.

Parameters:

amImageConfigurationEntry - the configuration used to create the adaptive media image

fileVersion - the file version used to create the adaptive media image

height - the adaptive media image's height

width - the adaptive media image's width

inputStream - the adaptive media image's input stream to store in the file store

size - the adaptive media image's size

Returns:

the adaptive media image

Throws:

PortalException - if an adaptive media image already exists for the file version and configuration

addAMImageEntry

public static AMImageEntry addAMImageEntry(AMImageEntry amImageEntry)

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

Important: Inspect AMImageEntryLocalServiceImpl 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:

amImageEntry - the am image entry

Returns:

the am image entry that was added

createAMImageEntry

public static AMImageEntry createAMImageEntry(long amImageEntryId)

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

Parameters:

amImageEntryId - the primary key for the new am image entry

Returns:

the new am image entry

createPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

PortalException

deleteAMImageEntries

public static void deleteAMImageEntries(long companyId,
                                        AMImageConfigurationEntry amImageConfigurationEntry)

Deletes all the adaptive media images generated for the configuration in the company. This method deletes both the adaptive media image entry from the database and the bytes from the file store.

Parameters:

companyId - the primary key of the company

amImageConfigurationEntry - the configuration used to create the adaptive media image

deleteAMImageEntry

public static AMImageEntry deleteAMImageEntry(AMImageEntry amImageEntry)

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

Important: Inspect AMImageEntryLocalServiceImpl 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:

amImageEntry - the am image entry

Returns:

the am image entry that was removed

deleteAMImageEntry

public static AMImageEntry deleteAMImageEntry(long amImageEntryId)
                                       throws com.liferay.portal.kernel.exception.PortalException

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

Important: Inspect AMImageEntryLocalServiceImpl 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:

amImageEntryId - the primary key of the am image entry

Returns:

the am image entry that was removed

Throws:

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

deleteAMImageEntryFileVersion

public static void deleteAMImageEntryFileVersion(com.liferay.portal.kernel.repository.model.FileVersion fileVersion)
                                          throws com.liferay.portal.kernel.exception.PortalException

Deletes all the adaptive media images generated for a file version. This method deletes both the adaptive media image entry from the database and the bytes from the file store.

Parameters:

fileVersion - the file version

Throws:

PortalException - if the file version was not found

deleteAMImageEntryFileVersion

public static void deleteAMImageEntryFileVersion(java.lang.String configurationUuid,
                                                 long fileVersionId)
                                          throws com.liferay.portal.kernel.exception.PortalException

Deletes adaptive media images generated for a file version under a given configuration. This method deletes both the adaptive media image entry from the database and the bytes from the file store.

Parameters:

configurationUuid - the configuration UUID

fileVersionId - the primary key of the file version

Throws:

PortalException - if the file version was not found

deletePersistedModel

public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

PortalException

dslQuery

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

dynamicQuery

public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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.adaptive.media.image.model.impl.AMImageEntryModelImpl.

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> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end,
                                                 com.liferay.portal.kernel.util.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.adaptive.media.image.model.impl.AMImageEntryModelImpl.

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(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                     com.liferay.portal.kernel.dao.orm.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

fetchAMImageEntry

public static AMImageEntry fetchAMImageEntry(long amImageEntryId)

fetchAMImageEntry

public static AMImageEntry fetchAMImageEntry(java.lang.String configurationUuid,
                                             long fileVersionId)

Returns the adaptive media image entry generated for the configuration and file version.

Parameters:

configurationUuid - the UUID of the configuration used to create the adaptive media image

fileVersionId - the primary key of the file version

Returns:

the matching adaptive media image entry, or null if a matching adaptive media image entry could not be found

fetchAMImageEntryByUuidAndGroupId

public static AMImageEntry fetchAMImageEntryByUuidAndGroupId(java.lang.String uuid,
                                                             long groupId)

Returns the am image entry matching the UUID and group.

Parameters:

uuid - the am image entry's UUID

groupId - the primary key of the group

Returns:

the matching am image entry, or null if a matching am image entry could not be found

getActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getAMImageEntries

public static java.util.List<AMImageEntry> getAMImageEntries(int start,
                                                             int end)

Returns a range of all the am image entries.

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.adaptive.media.image.model.impl.AMImageEntryModelImpl.

Parameters:

start - the lower bound of the range of am image entries

end - the upper bound of the range of am image entries (not inclusive)

Returns:

the range of am image entries

getAMImageEntries

public static java.util.List<AMImageEntry> getAMImageEntries(long fileVersionId)

Returns the list of adaptive media image entries generated for the file version.

Parameters:

fileVersionId - the primary key of the file version

Returns:

the list of adaptive media image entries in the file version

getAMImageEntriesByUuidAndCompanyId

public static java.util.List<AMImageEntry> getAMImageEntriesByUuidAndCompanyId(java.lang.String uuid,
                                                                               long companyId)

Returns all the am image entries matching the UUID and company.

Parameters:

uuid - the UUID of the am image entries

companyId - the primary key of the company

Returns:

the matching am image entries, or an empty list if no matches were found

getAMImageEntriesByUuidAndCompanyId

public static java.util.List<AMImageEntry> getAMImageEntriesByUuidAndCompanyId(java.lang.String uuid,
                                                                               long companyId,
                                                                               int start,
                                                                               int end,
                                                                               com.liferay.portal.kernel.util.OrderByComparator<AMImageEntry> orderByComparator)

Returns a range of am image entries matching the UUID and company.

Parameters:

uuid - the UUID of the am image entries

companyId - the primary key of the company

start - the lower bound of the range of am image entries

end - the upper bound of the range of am image entries (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the range of matching am image entries, or an empty list if no matches were found

getAMImageEntriesCount

public static int getAMImageEntriesCount()

Returns the number of am image entries.

Returns:

the number of am image entries

getAMImageEntriesCount

public static int getAMImageEntriesCount(long companyId,
                                         java.lang.String configurationUuid)

Returns the number of adaptive media image entries generated for the configuration in the company.

Parameters:

companyId - the primary key of the company

configurationUuid - the UUID of the configuration used to create the adaptive media image

Returns:

the number of adaptive media image entries in the company for the configuration

getAMImageEntry

public static AMImageEntry getAMImageEntry(long amImageEntryId)
                                    throws com.liferay.portal.kernel.exception.PortalException

Returns the am image entry with the primary key.

Parameters:

amImageEntryId - the primary key of the am image entry

Returns:

the am image entry

Throws:

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

getAMImageEntryByUuidAndGroupId

public static AMImageEntry getAMImageEntryByUuidAndGroupId(java.lang.String uuid,
                                                           long groupId)
                                                    throws com.liferay.portal.kernel.exception.PortalException

Returns the am image entry matching the UUID and group.

Parameters:

uuid - the am image entry's UUID

groupId - the primary key of the group

Returns:

the matching am image entry

Throws:

PortalException - if a matching am image entry could not be found

getAMImageEntryContentStream

public static java.io.InputStream getAMImageEntryContentStream(AMImageConfigurationEntry amImageConfigurationEntry,
                                                               com.liferay.portal.kernel.repository.model.FileVersion fileVersion)

Returns the input stream of the adaptive media image generated for a file version and configuration.

Parameters:

amImageConfigurationEntry - the configuration used to create the adaptive media image

fileVersion - the file version used to create the adaptive media image

Returns:

the input stream of the adaptive media image generated for a file version and configuration

getExpectedAMImageEntriesCount

public static int getExpectedAMImageEntriesCount(long companyId)

Returns the total number of adaptive media images that are expected to be in a company once they are generated. The number of adaptive media images could be less if there are images that haven't generated the adaptive media image yet.

Parameters:

companyId - the primary key of the company

Returns:

the number of expected adaptive media images for a company

getIndexableActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPercentage

public static int getPercentage(long companyId,
                                java.lang.String configurationUuid)

Returns the percentage of images that have an adaptive media image generated based on the expected number of adaptive media images for a configuration in a company.

Parameters:

companyId - the primary key of the company

configurationUuid - the UUID of the configuration used to create the adaptive media image

Returns:

the percentage of images that have an adaptive media image out of the expected adaptive media images

getPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

PortalException

updateAMImageEntry

public static AMImageEntry updateAMImageEntry(AMImageEntry amImageEntry)

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

Important: Inspect AMImageEntryLocalServiceImpl 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:

amImageEntry - the am image entry

Returns:

the am image entry that was updated

getService

public static AMImageEntryLocalService getService()