Class AnalyticsMessageLocalServiceUtil

java.lang.Object
com.liferay.analytics.message.storage.service.AnalyticsMessageLocalServiceUtil

public class AnalyticsMessageLocalServiceUtil extends Object
Provides the local service utility for AnalyticsMessage. This utility wraps com.liferay.analytics.message.storage.service.impl.AnalyticsMessageLocalServiceImpl 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:
Generated:
  • Constructor Details

    • AnalyticsMessageLocalServiceUtil

      public AnalyticsMessageLocalServiceUtil()
  • Method Details

    • addAnalyticsMessage

      public static AnalyticsMessage addAnalyticsMessage(AnalyticsMessage analyticsMessage)
      Adds the analytics message to the database. Also notifies the appropriate model listeners.

      Important: Inspect AnalyticsMessageLocalServiceImpl 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:
      analyticsMessage - the analytics message
      Returns:
      the analytics message that was added
    • addAnalyticsMessage

      public static AnalyticsMessage addAnalyticsMessage(long companyId, long userId, byte[] body) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createAnalyticsMessage

      public static AnalyticsMessage createAnalyticsMessage(long analyticsMessageId)
      Creates a new analytics message with the primary key. Does not add the analytics message to the database.
      Parameters:
      analyticsMessageId - the primary key for the new analytics message
      Returns:
      the new analytics message
    • createPersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteAnalyticsMessage

      public static AnalyticsMessage deleteAnalyticsMessage(AnalyticsMessage analyticsMessage)
      Deletes the analytics message from the database. Also notifies the appropriate model listeners.

      Important: Inspect AnalyticsMessageLocalServiceImpl 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:
      analyticsMessage - the analytics message
      Returns:
      the analytics message that was removed
    • deleteAnalyticsMessage

      public static AnalyticsMessage deleteAnalyticsMessage(long analyticsMessageId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the analytics message with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect AnalyticsMessageLocalServiceImpl 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:
      analyticsMessageId - the primary key of the analytics message
      Returns:
      the analytics message that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a analytics message with the primary key could not be found
    • deleteAnalyticsMessages

      public static void deleteAnalyticsMessages(List<AnalyticsMessage> analyticsMessages)
    • deleteAnalyticsMessages

      public static void deleteAnalyticsMessages(long companyId)
    • 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:
      com.liferay.portal.kernel.exception.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 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      public static <T> 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> 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.analytics.message.storage.model.impl.AnalyticsMessageModelImpl.

      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(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.analytics.message.storage.model.impl.AnalyticsMessageModelImpl.

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

      public static AnalyticsMessage fetchAnalyticsMessage(long analyticsMessageId)
    • getActionableDynamicQuery

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

      public static AnalyticsMessage getAnalyticsMessage(long analyticsMessageId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the analytics message with the primary key.
      Parameters:
      analyticsMessageId - the primary key of the analytics message
      Returns:
      the analytics message
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a analytics message with the primary key could not be found
    • getAnalyticsMessages

      public static List<AnalyticsMessage> getAnalyticsMessages(int start, int end)
      Returns a range of all the analytics messages.

      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.analytics.message.storage.model.impl.AnalyticsMessageModelImpl.

      Parameters:
      start - the lower bound of the range of analytics messages
      end - the upper bound of the range of analytics messages (not inclusive)
      Returns:
      the range of analytics messages
    • getAnalyticsMessages

      public static List<AnalyticsMessage> getAnalyticsMessages(long companyId, int start, int end)
    • getAnalyticsMessagesCount

      public static int getAnalyticsMessagesCount()
      Returns the number of analytics messages.
      Returns:
      the number of analytics messages
    • getBodyBlobModel

      public static AnalyticsMessageBodyBlobModel getBodyBlobModel(Serializable primaryKey)
    • getCompanyIds

      public static List<Long> getCompanyIds()
    • getIndexableActionableDynamicQuery

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

      public static String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • openBodyInputStream

      public static InputStream openBodyInputStream(long analyticsMessageId)
    • updateAnalyticsMessage

      public static AnalyticsMessage updateAnalyticsMessage(AnalyticsMessage analyticsMessage)
      Updates the analytics message in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect AnalyticsMessageLocalServiceImpl 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:
      analyticsMessage - the analytics message
      Returns:
      the analytics message that was updated
    • getService

      public static AnalyticsMessageLocalService getService()