Interface AuditEventLocalService

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

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

    • addAuditEvent

      @Indexable(type=REINDEX) AuditEvent addAuditEvent(AuditEvent auditEvent)
      Adds the audit event to the database. Also notifies the appropriate model listeners.

      Important: Inspect AuditEventLocalServiceImpl 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:
      auditEvent - the audit event
      Returns:
      the audit event that was added
    • addAuditEvent

      AuditEvent addAuditEvent(com.liferay.portal.kernel.audit.AuditMessage auditMessage)
    • addAuditEvents

      void addAuditEvents(List<com.liferay.portal.kernel.audit.AuditMessage> auditMessages)
    • createAuditEvent

      @Transactional(enabled=false) AuditEvent createAuditEvent(long auditEventId)
      Creates a new audit event with the primary key. Does not add the audit event to the database.
      Parameters:
      auditEventId - the primary key for the new audit event
      Returns:
      the new audit event
    • 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
    • deleteAuditEvent

      @Indexable(type=DELETE) AuditEvent deleteAuditEvent(AuditEvent auditEvent)
      Deletes the audit event from the database. Also notifies the appropriate model listeners.

      Important: Inspect AuditEventLocalServiceImpl 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:
      auditEvent - the audit event
      Returns:
      the audit event that was removed
    • deleteAuditEvent

      @Indexable(type=DELETE) AuditEvent deleteAuditEvent(long auditEventId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the audit event with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect AuditEventLocalServiceImpl 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:
      auditEventId - the primary key of the audit event
      Returns:
      the audit event that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a audit event 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.portal.security.audit.storage.model.impl.AuditEventModelImpl.

      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.portal.security.audit.storage.model.impl.AuditEventModelImpl.

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

      @Transactional(propagation=SUPPORTS, readOnly=true) AuditEvent fetchAuditEvent(long auditEventId)
    • getActionableDynamicQuery

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

      @Transactional(propagation=SUPPORTS, readOnly=true) AuditEvent getAuditEvent(long auditEventId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the audit event with the primary key.
      Parameters:
      auditEventId - the primary key of the audit event
      Returns:
      the audit event
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a audit event with the primary key could not be found
    • getAuditEvents

      @Transactional(propagation=SUPPORTS, readOnly=true) List<AuditEvent> getAuditEvents(int start, int end)
      Returns a range of all the audit 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.security.audit.storage.model.impl.AuditEventModelImpl.

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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<AuditEvent> getAuditEvents(long companyId, int start, int end)
    • getAuditEvents

      @Transactional(propagation=SUPPORTS, readOnly=true) List<AuditEvent> getAuditEvents(long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<AuditEvent> orderByComparator)
    • getAuditEvents

      @Transactional(propagation=SUPPORTS, readOnly=true) List<AuditEvent> getAuditEvents(long companyId, long groupId, long userId, String userName, Date createDateGT, Date createDateLT, String eventType, String className, String classPK, String clientHost, String clientIP, String serverName, int serverPort, String sessionID, boolean andSearch, int start, int end)
    • getAuditEvents

      @Transactional(propagation=SUPPORTS, readOnly=true) List<AuditEvent> getAuditEvents(long companyId, long groupId, long userId, String userName, Date createDateGT, Date createDateLT, String eventType, String className, String classPK, String clientHost, String clientIP, String serverName, int serverPort, String sessionID, boolean andSearch, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<AuditEvent> orderByComparator)
    • getAuditEventsCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getAuditEventsCount()
      Returns the number of audit events.
      Returns:
      the number of audit events
    • getAuditEventsCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getAuditEventsCount(long companyId)
    • getAuditEventsCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getAuditEventsCount(long companyId, long groupId, long userId, String userName, Date createDateGT, Date createDateLT, String eventType, String className, String classPK, String clientHost, String clientIP, String serverName, int serverPort, String sessionID, boolean andSearch)
    • getIndexableActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • 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
    • updateAuditEvent

      @Indexable(type=REINDEX) AuditEvent updateAuditEvent(AuditEvent auditEvent)
      Updates the audit event in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect AuditEventLocalServiceImpl 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:
      auditEvent - the audit event
      Returns:
      the audit event that was updated