Class AnnouncementsDeliveryLocalServiceUtil

Object
com.liferay.announcements.kernel.service.AnnouncementsDeliveryLocalServiceUtil

public class AnnouncementsDeliveryLocalServiceUtil extends Object
Provides the local service utility for AnnouncementsDelivery. This utility wraps com.liferay.portlet.announcements.service.impl.AnnouncementsDeliveryLocalServiceImpl 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

    • AnnouncementsDeliveryLocalServiceUtil

      public AnnouncementsDeliveryLocalServiceUtil()
  • Method Details

    • addAnnouncementsDelivery

      public static AnnouncementsDelivery addAnnouncementsDelivery(AnnouncementsDelivery announcementsDelivery)
      Adds the announcements delivery to the database. Also notifies the appropriate model listeners.

      Important: Inspect AnnouncementsDeliveryLocalServiceImpl 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:
      announcementsDelivery - the announcements delivery
      Returns:
      the announcements delivery that was added
    • addUserDelivery

      public static AnnouncementsDelivery addUserDelivery(long userId, String type) throws PortalException
      Throws:
      PortalException
    • createAnnouncementsDelivery

      public static AnnouncementsDelivery createAnnouncementsDelivery(long deliveryId)
      Creates a new announcements delivery with the primary key. Does not add the announcements delivery to the database.
      Parameters:
      deliveryId - the primary key for the new announcements delivery
      Returns:
      the new announcements delivery
    • createPersistedModel

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

      public static AnnouncementsDelivery deleteAnnouncementsDelivery(AnnouncementsDelivery announcementsDelivery)
      Deletes the announcements delivery from the database. Also notifies the appropriate model listeners.

      Important: Inspect AnnouncementsDeliveryLocalServiceImpl 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:
      announcementsDelivery - the announcements delivery
      Returns:
      the announcements delivery that was removed
    • deleteAnnouncementsDelivery

      public static AnnouncementsDelivery deleteAnnouncementsDelivery(long deliveryId) throws PortalException
      Deletes the announcements delivery with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect AnnouncementsDeliveryLocalServiceImpl 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:
      deliveryId - the primary key of the announcements delivery
      Returns:
      the announcements delivery that was removed
      Throws:
      PortalException - if a announcements delivery with the primary key could not be found
    • deleteDeliveries

      public static void deleteDeliveries(long userId)
    • deleteDelivery

      public static void deleteDelivery(AnnouncementsDelivery delivery)
    • deleteDelivery

      public static void deleteDelivery(long deliveryId) throws PortalException
      Throws:
      PortalException
    • deleteDelivery

      public static void deleteDelivery(long userId, String type)
    • 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.portlet.announcements.model.impl.AnnouncementsDeliveryModelImpl.

      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.portlet.announcements.model.impl.AnnouncementsDeliveryModelImpl.

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

      public static AnnouncementsDelivery fetchAnnouncementsDelivery(long deliveryId)
    • getActionableDynamicQuery

      public static ActionableDynamicQuery getActionableDynamicQuery()
    • getAnnouncementsDeliveries

      public static List<AnnouncementsDelivery> getAnnouncementsDeliveries(int start, int end)
      Returns a range of all the announcements deliveries.

      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.portlet.announcements.model.impl.AnnouncementsDeliveryModelImpl.

      Parameters:
      start - the lower bound of the range of announcements deliveries
      end - the upper bound of the range of announcements deliveries (not inclusive)
      Returns:
      the range of announcements deliveries
    • getAnnouncementsDeliveriesCount

      public static int getAnnouncementsDeliveriesCount()
      Returns the number of announcements deliveries.
      Returns:
      the number of announcements deliveries
    • getAnnouncementsDelivery

      public static AnnouncementsDelivery getAnnouncementsDelivery(long deliveryId) throws PortalException
      Returns the announcements delivery with the primary key.
      Parameters:
      deliveryId - the primary key of the announcements delivery
      Returns:
      the announcements delivery
      Throws:
      PortalException - if a announcements delivery with the primary key could not be found
    • getDelivery

      public static AnnouncementsDelivery getDelivery(long deliveryId) throws PortalException
      Throws:
      PortalException
    • 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
    • getUserDeliveries

      public static List<AnnouncementsDelivery> getUserDeliveries(long userId) throws PortalException
      Throws:
      PortalException
    • getUserDelivery

      public static AnnouncementsDelivery getUserDelivery(long userId, String type) throws PortalException
      Throws:
      PortalException
    • updateAnnouncementsDelivery

      public static AnnouncementsDelivery updateAnnouncementsDelivery(AnnouncementsDelivery announcementsDelivery)
      Updates the announcements delivery in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect AnnouncementsDeliveryLocalServiceImpl 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:
      announcementsDelivery - the announcements delivery
      Returns:
      the announcements delivery that was updated
    • updateDelivery

      public static AnnouncementsDelivery updateDelivery(long userId, String type, boolean email, boolean sms) throws PortalException
      Throws:
      PortalException
    • getService

      public static AnnouncementsDeliveryLocalService getService()
    • setService

      public static void setService(AnnouncementsDeliveryLocalService service)