Interface CTMessageLocalService

All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
All Known Implementing Classes:
CTMessageLocalServiceWrapper

@ProviderType @Transactional(isolation=PORTAL, rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class}) public interface CTMessageLocalService extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
Provides the local service interface for CTMessage. 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:
  • Method Summary

    Modifier and Type
    Method
    Description
    addCTMessage(long ctCollectionId, com.liferay.portal.kernel.messaging.Message message)
     
    Adds the ct message to the database.
    createCTMessage(long ctMessageId)
    Creates a new ct message with the primary key.
    com.liferay.portal.kernel.model.PersistedModel
     
    deleteCTMessage(long ctMessageId)
    Deletes the ct message with the primary key from the database.
    Deletes the ct message from the database.
    com.liferay.portal.kernel.model.PersistedModel
    deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
     
    <T> T
    dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
     
    int
    dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
     
    com.liferay.portal.kernel.dao.orm.DynamicQuery
     
    <T> List<T>
    dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
    Performs a dynamic query on the database and returns the matching rows.
    <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.
    <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.
    long
    dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
    Returns the number of rows matching the dynamic query.
    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.
    fetchCTMessage(long ctMessageId)
     
    com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
     
    getCTMessage(long ctMessageId)
    Returns the ct message with the primary key.
    getCTMessages(int start, int end)
    Returns a range of all the ct messages.
    int
    Returns the number of ct messages.
    com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
     
    List<com.liferay.portal.kernel.messaging.Message>
    getMessages(long ctCollectionId)
     
    Returns the OSGi service identifier.
    com.liferay.portal.kernel.model.PersistedModel
     
    Updates the ct message in the database or adds it if it does not yet exist.

    Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService

    fetchPersistedModel, getBasePersistence
  • Method Details

    • addCTMessage

      @Indexable(type=REINDEX) CTMessage addCTMessage(CTMessage ctMessage)
      Adds the ct message to the database. Also notifies the appropriate model listeners.

      Important: Inspect CTMessageLocalServiceImpl 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:
      ctMessage - the ct message
      Returns:
      the ct message that was added
    • addCTMessage

      CTMessage addCTMessage(long ctCollectionId, com.liferay.portal.kernel.messaging.Message message)
    • createCTMessage

      @Transactional(enabled=false) CTMessage createCTMessage(long ctMessageId)
      Creates a new ct message with the primary key. Does not add the ct message to the database.
      Parameters:
      ctMessageId - the primary key for the new ct message
      Returns:
      the new ct message
    • createPersistedModel

      com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCTMessage

      @Indexable(type=DELETE) CTMessage deleteCTMessage(CTMessage ctMessage)
      Deletes the ct message from the database. Also notifies the appropriate model listeners.

      Important: Inspect CTMessageLocalServiceImpl 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:
      ctMessage - the ct message
      Returns:
      the ct message that was removed
    • deleteCTMessage

      @Indexable(type=DELETE) CTMessage deleteCTMessage(long ctMessageId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the ct message with the primary key from the database. Also notifies the appropriate model listeners.

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

      com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • dslQuery

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

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

      @Transactional(propagation=SUPPORTS, readOnly=true) <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.change.tracking.model.impl.CTMessageModelImpl.

      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(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.change.tracking.model.impl.CTMessageModelImpl.

      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(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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) CTMessage fetchCTMessage(long ctMessageId)
    • getActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getCTMessage

      @Transactional(propagation=SUPPORTS, readOnly=true) CTMessage getCTMessage(long ctMessageId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the ct message with the primary key.
      Parameters:
      ctMessageId - the primary key of the ct message
      Returns:
      the ct message
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a ct message with the primary key could not be found
    • getCTMessages

      @Transactional(propagation=SUPPORTS, readOnly=true) List<CTMessage> getCTMessages(int start, int end)
      Returns a range of all the ct 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.change.tracking.model.impl.CTMessageModelImpl.

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

      @Transactional(propagation=SUPPORTS, readOnly=true) int getCTMessagesCount()
      Returns the number of ct messages.
      Returns:
      the number of ct messages
    • getIndexableActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getMessages

      @Transactional(propagation=SUPPORTS, readOnly=true) List<com.liferay.portal.kernel.messaging.Message> getMessages(long ctCollectionId)
    • getOSGiServiceIdentifier

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

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateCTMessage

      @Indexable(type=REINDEX) CTMessage updateCTMessage(CTMessage ctMessage)
      Updates the ct message in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect CTMessageLocalServiceImpl 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:
      ctMessage - the ct message
      Returns:
      the ct message that was updated