Package com.liferay.portal.kernel.service

Interface SystemEventLocalService

All Superinterfaces:
BaseLocalService, CTService<SystemEvent>, PersistedModelLocalService
All Known Implementing Classes:
SystemEventLocalServiceWrapper
@CTAware @ProviderType @Transactional(isolation=PORTAL, rollbackFor={PortalException.class,SystemException.class}) public interface SystemEventLocalService extends BaseLocalService, CTService<SystemEvent>, PersistedModelLocalService
Provides the local service interface for SystemEvent. 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:

  • Method Details

    • addSystemEvent

      SystemEvent addSystemEvent(long userId, long groupId, String classExternalReferenceCode, String className, long classPK, String classUuid, String referrerClassName, int type, String extraData) throws PortalException
      Throws:
      PortalException

    • addSystemEvent

      SystemEvent addSystemEvent(long companyId, String classExternalReferenceCode, String className, long classPK, String classUuid, String referrerClassName, int type, String extraData) throws PortalException
      Throws:
      PortalException

    • addSystemEvent

      @Indexable(type=REINDEX) SystemEvent addSystemEvent(SystemEvent systemEvent)
      Adds the system event to the database. Also notifies the appropriate model listeners.

      Important: Inspect SystemEventLocalServiceImpl 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:
      systemEvent - the system event
      Returns:
      the system event that was added

    • checkSystemEvents

      void checkSystemEvents() throws PortalException
      Throws:
      PortalException

    • createPersistedModel

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

    • createSystemEvent

      @Transactional(enabled=false) SystemEvent createSystemEvent(long systemEventId)
      Creates a new system event with the primary key. Does not add the system event to the database.
      Parameters:
      systemEventId - the primary key for the new system event
      Returns:
      the new system event

    • deletePersistedModel

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

    • deleteSystemEvent

      @Indexable(type=DELETE) SystemEvent deleteSystemEvent(long systemEventId) throws PortalException
      Deletes the system event with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect SystemEventLocalServiceImpl 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:
      systemEventId - the primary key of the system event
      Returns:
      the system event that was removed
      Throws:
      PortalException - if a system event with the primary key could not be found

    • deleteSystemEvent

      @Indexable(type=DELETE) SystemEvent deleteSystemEvent(SystemEvent systemEvent)
      Deletes the system event from the database. Also notifies the appropriate model listeners.

      Important: Inspect SystemEventLocalServiceImpl 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:
      systemEvent - the system event
      Returns:
      the system event that was removed

    • deleteSystemEvents

      void deleteSystemEvents(long groupId)

    • deleteSystemEvents

      void deleteSystemEvents(long groupId, long systemEventSetKey)

    • 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

      @Transactional(propagation=SUPPORTS, readOnly=true) DynamicQuery 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.portal.model.impl.SystemEventModelImpl.

      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.portal.model.impl.SystemEventModelImpl.

      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

    • fetchSystemEvent

      @Transactional(propagation=SUPPORTS, readOnly=true) SystemEvent fetchSystemEvent(long systemEventId)

    • fetchSystemEvent

      @Transactional(propagation=SUPPORTS, readOnly=true) SystemEvent fetchSystemEvent(long groupId, long classNameId, long classPK, int type)

    • getActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery()

    • 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

    • getSystemEvent

      @Transactional(propagation=SUPPORTS, readOnly=true) SystemEvent getSystemEvent(long systemEventId) throws PortalException
      Returns the system event with the primary key.
      Parameters:
      systemEventId - the primary key of the system event
      Returns:
      the system event
      Throws:
      PortalException - if a system event with the primary key could not be found

    • getSystemEvents

      @Transactional(propagation=SUPPORTS, readOnly=true) List<SystemEvent> getSystemEvents(int start, int end)
      Returns a range of all the system events.

      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.portal.model.impl.SystemEventModelImpl.

      Parameters:
      start - the lower bound of the range of system events
      end - the upper bound of the range of system events (not inclusive)
      Returns:
      the range of system events

    • getSystemEvents

      @Transactional(propagation=SUPPORTS, readOnly=true) List<SystemEvent> getSystemEvents(long groupId, long classNameId, long classPK)

    • getSystemEvents

      @Transactional(propagation=SUPPORTS, readOnly=true) List<SystemEvent> getSystemEvents(long groupId, long classNameId, long classPK, int type)

    • getSystemEventsCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getSystemEventsCount()
      Returns the number of system events.
      Returns:
      the number of system events

    • updateSystemEvent

      @Indexable(type=REINDEX) SystemEvent updateSystemEvent(SystemEvent systemEvent)
      Updates the system event in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect SystemEventLocalServiceImpl 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:
      systemEvent - the system event
      Returns:
      the system event that was updated

    • validateGroup

      boolean validateGroup(long groupId) throws PortalException
      Throws:
      PortalException

    • getCTPersistence

      @Transactional(enabled=false) CTPersistence<SystemEvent> getCTPersistence()
      Specified by:
      getCTPersistence in interface CTService<SystemEvent>

    • getModelClass

      @Transactional(enabled=false) Class<SystemEvent> getModelClass()
      Specified by:
      getModelClass in interface CTService<SystemEvent>

    • updateWithUnsafeFunction

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