Interface AnnouncementsFlagLocalService

All Superinterfaces:
BaseLocalService, CTService<AnnouncementsFlag>, PersistedModelLocalService
All Known Implementing Classes:
AnnouncementsFlagLocalServiceWrapper

Provides the local service interface for AnnouncementsFlag. 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}
  • Method Details

    • addAnnouncementsFlag

      @Indexable(type=REINDEX) AnnouncementsFlag addAnnouncementsFlag(AnnouncementsFlag announcementsFlag)
      Adds the announcements flag to the database. Also notifies the appropriate model listeners.

      Important: Inspect AnnouncementsFlagLocalServiceImpl 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:
      announcementsFlag - the announcements flag
      Returns:
      the announcements flag that was added
    • addFlag

      AnnouncementsFlag addFlag(long userId, long entryId, int value)
    • createAnnouncementsFlag

      @Transactional(enabled=false) AnnouncementsFlag createAnnouncementsFlag(long flagId)
      Creates a new announcements flag with the primary key. Does not add the announcements flag to the database.
      Parameters:
      flagId - the primary key for the new announcements flag
      Returns:
      the new announcements flag
    • createPersistedModel

      PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Specified by:
      createPersistedModel in interface PersistedModelLocalService
      Throws:
      PortalException
    • deleteAnnouncementsFlag

      @Indexable(type=DELETE) AnnouncementsFlag deleteAnnouncementsFlag(AnnouncementsFlag announcementsFlag)
      Deletes the announcements flag from the database. Also notifies the appropriate model listeners.

      Important: Inspect AnnouncementsFlagLocalServiceImpl 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:
      announcementsFlag - the announcements flag
      Returns:
      the announcements flag that was removed
    • deleteAnnouncementsFlag

      @Indexable(type=DELETE) AnnouncementsFlag deleteAnnouncementsFlag(long flagId) throws PortalException
      Deletes the announcements flag with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect AnnouncementsFlagLocalServiceImpl 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:
      flagId - the primary key of the announcements flag
      Returns:
      the announcements flag that was removed
      Throws:
      PortalException - if a announcements flag with the primary key could not be found
    • deleteFlag

      void deleteFlag(AnnouncementsFlag flag)
    • deleteFlag

      void deleteFlag(long flagId) throws PortalException
      Throws:
      PortalException
    • deleteFlags

      void deleteFlags(long entryId)
    • deletePersistedModel

      PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
      Specified by:
      deletePersistedModel in interface PersistedModelLocalService
      Throws:
      PortalException
    • dslQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQuery in interface PersistedModelLocalService
    • dslQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface PersistedModelLocalService
    • dynamicQuery

    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <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

      @Transactional(propagation=SUPPORTS, readOnly=true) <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.AnnouncementsFlagModelImpl.

      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

      @Transactional(propagation=SUPPORTS, readOnly=true) <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.AnnouncementsFlagModelImpl.

      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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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
    • fetchAnnouncementsFlag

      @Transactional(propagation=SUPPORTS, readOnly=true) AnnouncementsFlag fetchAnnouncementsFlag(long flagId)
    • getActionableDynamicQuery

    • getAnnouncementsFlag

      @Transactional(propagation=SUPPORTS, readOnly=true) AnnouncementsFlag getAnnouncementsFlag(long flagId) throws PortalException
      Returns the announcements flag with the primary key.
      Parameters:
      flagId - the primary key of the announcements flag
      Returns:
      the announcements flag
      Throws:
      PortalException - if a announcements flag with the primary key could not be found
    • getAnnouncementsFlags

      @Transactional(propagation=SUPPORTS, readOnly=true) List<AnnouncementsFlag> getAnnouncementsFlags(int start, int end)
      Returns a range of all the announcements flags.

      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.AnnouncementsFlagModelImpl.

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

      @Transactional(propagation=SUPPORTS, readOnly=true) int getAnnouncementsFlagsCount()
      Returns the number of announcements flags.
      Returns:
      the number of announcements flags
    • getFlag

      @Transactional(propagation=SUPPORTS, readOnly=true) AnnouncementsFlag getFlag(long userId, long entryId, int value) throws PortalException
      Throws:
      PortalException
    • getIndexableActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

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

      @Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
      Specified by:
      getPersistedModel in interface PersistedModelLocalService
      Throws:
      PortalException
    • updateAnnouncementsFlag

      @Indexable(type=REINDEX) AnnouncementsFlag updateAnnouncementsFlag(AnnouncementsFlag announcementsFlag)
      Updates the announcements flag in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect AnnouncementsFlagLocalServiceImpl 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:
      announcementsFlag - the announcements flag
      Returns:
      the announcements flag that was updated
    • getCTPersistence

      Specified by:
      getCTPersistence in interface CTService<AnnouncementsFlag>
    • getModelClass

      Specified by:
      getModelClass in interface CTService<AnnouncementsFlag>
    • updateWithUnsafeFunction

      @Transactional(rollbackFor=java.lang.Throwable.class) <R, E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<AnnouncementsFlag>,R,E> updateUnsafeFunction) throws E
      Specified by:
      updateWithUnsafeFunction in interface CTService<AnnouncementsFlag>
      Throws:
      E extends Throwable