com.liferay.portal.security.audit.storage.service.persistence.AuditEventUtil Maven / Gradle / Ivy
/**
* Copyright (c) 2000-present Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.portal.security.audit.storage.service.persistence;
import aQute.bnd.annotation.ProviderType;
import com.liferay.portal.kernel.dao.orm.DynamicQuery;
import com.liferay.portal.kernel.service.ServiceContext;
import com.liferay.portal.kernel.util.OrderByComparator;
import com.liferay.portal.security.audit.storage.model.AuditEvent;
import java.io.Serializable;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.osgi.framework.Bundle;
import org.osgi.framework.FrameworkUtil;
import org.osgi.util.tracker.ServiceTracker;
/**
* The persistence utility for the audit event service. This utility wraps com.liferay.portal.security.audit.storage.service.persistence.impl.AuditEventPersistenceImpl and provides direct access to the database for CRUD operations. This utility should only be used by the service layer, as it must operate within a transaction. Never access this utility in a JSP, controller, model, or other front-end class.
*
*
* Caching information and settings can be found in portal.properties
*
*
* @author Brian Wing Shun Chan
* @see AuditEventPersistence
* @generated
*/
@ProviderType
public class AuditEventUtil {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this class directly. Modify service.xml and rerun ServiceBuilder to regenerate this class.
*/
/**
* @see com.liferay.portal.kernel.service.persistence.BasePersistence#clearCache()
*/
public static void clearCache() {
getPersistence().clearCache();
}
/**
* @see com.liferay.portal.kernel.service.persistence.BasePersistence#clearCache(com.liferay.portal.kernel.model.BaseModel)
*/
public static void clearCache(AuditEvent auditEvent) {
getPersistence().clearCache(auditEvent);
}
/**
* @see com.liferay.portal.kernel.service.persistence.BasePersistence#countWithDynamicQuery(DynamicQuery)
*/
public static long countWithDynamicQuery(DynamicQuery dynamicQuery) {
return getPersistence().countWithDynamicQuery(dynamicQuery);
}
/**
* @see com.liferay.portal.kernel.service.persistence.BasePersistence#fetchByPrimaryKeys(Set)
*/
public static Map fetchByPrimaryKeys(
Set primaryKeys) {
return getPersistence().fetchByPrimaryKeys(primaryKeys);
}
/**
* @see com.liferay.portal.kernel.service.persistence.BasePersistence#findWithDynamicQuery(DynamicQuery)
*/
public static List findWithDynamicQuery(
DynamicQuery dynamicQuery) {
return getPersistence().findWithDynamicQuery(dynamicQuery);
}
/**
* @see com.liferay.portal.kernel.service.persistence.BasePersistence#findWithDynamicQuery(DynamicQuery, int, int)
*/
public static List findWithDynamicQuery(
DynamicQuery dynamicQuery, int start, int end) {
return getPersistence().findWithDynamicQuery(dynamicQuery, start, end);
}
/**
* @see com.liferay.portal.kernel.service.persistence.BasePersistence#findWithDynamicQuery(DynamicQuery, int, int, OrderByComparator)
*/
public static List findWithDynamicQuery(
DynamicQuery dynamicQuery, int start, int end,
OrderByComparator orderByComparator) {
return getPersistence().findWithDynamicQuery(
dynamicQuery, start, end, orderByComparator);
}
/**
* @see com.liferay.portal.kernel.service.persistence.BasePersistence#update(com.liferay.portal.kernel.model.BaseModel)
*/
public static AuditEvent update(AuditEvent auditEvent) {
return getPersistence().update(auditEvent);
}
/**
* @see com.liferay.portal.kernel.service.persistence.BasePersistence#update(com.liferay.portal.kernel.model.BaseModel, ServiceContext)
*/
public static AuditEvent update(
AuditEvent auditEvent, ServiceContext serviceContext) {
return getPersistence().update(auditEvent, serviceContext);
}
/**
* Returns all the audit events where companyId = ?.
*
* @param companyId the company ID
* @return the matching audit events
*/
public static List findByCompanyId(long companyId) {
return getPersistence().findByCompanyId(companyId);
}
/**
* Returns a range of all the audit events where companyId = ?.
*
*
* 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 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 and pagination is required (start and end are not QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from AuditEventModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
*
*
* @param companyId the company ID
* @param start the lower bound of the range of audit events
* @param end the upper bound of the range of audit events (not inclusive)
* @return the range of matching audit events
*/
public static List findByCompanyId(
long companyId, int start, int end) {
return getPersistence().findByCompanyId(companyId, start, end);
}
/**
* Returns an ordered range of all the audit events where companyId = ?.
*
*
* 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 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 and pagination is required (start and end are not QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from AuditEventModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
*
*
* @param companyId the company ID
* @param start the lower bound of the range of audit events
* @param end the upper bound of the range of audit events (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching audit events
*/
public static List findByCompanyId(
long companyId, int start, int end,
OrderByComparator orderByComparator) {
return getPersistence().findByCompanyId(
companyId, start, end, orderByComparator);
}
/**
* Returns an ordered range of all the audit events where companyId = ?.
*
*
* 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 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 and pagination is required (start and end are not QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from AuditEventModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
*
*
* @param companyId the company ID
* @param start the lower bound of the range of audit events
* @param end the upper bound of the range of audit events (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @param retrieveFromCache whether to retrieve from the finder cache
* @return the ordered range of matching audit events
*/
public static List findByCompanyId(
long companyId, int start, int end,
OrderByComparator orderByComparator,
boolean retrieveFromCache) {
return getPersistence().findByCompanyId(
companyId, start, end, orderByComparator, retrieveFromCache);
}
/**
* Returns the first audit event in the ordered set where companyId = ?.
*
* @param companyId the company ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching audit event
* @throws NoSuchEventException if a matching audit event could not be found
*/
public static AuditEvent findByCompanyId_First(
long companyId, OrderByComparator orderByComparator)
throws com.liferay.portal.security.audit.storage.exception.
NoSuchEventException {
return getPersistence().findByCompanyId_First(
companyId, orderByComparator);
}
/**
* Returns the first audit event in the ordered set where companyId = ?.
*
* @param companyId the company ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching audit event, or null if a matching audit event could not be found
*/
public static AuditEvent fetchByCompanyId_First(
long companyId, OrderByComparator orderByComparator) {
return getPersistence().fetchByCompanyId_First(
companyId, orderByComparator);
}
/**
* Returns the last audit event in the ordered set where companyId = ?.
*
* @param companyId the company ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching audit event
* @throws NoSuchEventException if a matching audit event could not be found
*/
public static AuditEvent findByCompanyId_Last(
long companyId, OrderByComparator orderByComparator)
throws com.liferay.portal.security.audit.storage.exception.
NoSuchEventException {
return getPersistence().findByCompanyId_Last(
companyId, orderByComparator);
}
/**
* Returns the last audit event in the ordered set where companyId = ?.
*
* @param companyId the company ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching audit event, or null if a matching audit event could not be found
*/
public static AuditEvent fetchByCompanyId_Last(
long companyId, OrderByComparator orderByComparator) {
return getPersistence().fetchByCompanyId_Last(
companyId, orderByComparator);
}
/**
* Returns the audit events before and after the current audit event in the ordered set where companyId = ?.
*
* @param auditEventId the primary key of the current audit event
* @param companyId the company ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the previous, current, and next audit event
* @throws NoSuchEventException if a audit event with the primary key could not be found
*/
public static AuditEvent[] findByCompanyId_PrevAndNext(
long auditEventId, long companyId,
OrderByComparator orderByComparator)
throws com.liferay.portal.security.audit.storage.exception.
NoSuchEventException {
return getPersistence().findByCompanyId_PrevAndNext(
auditEventId, companyId, orderByComparator);
}
/**
* Removes all the audit events where companyId = ? from the database.
*
* @param companyId the company ID
*/
public static void removeByCompanyId(long companyId) {
getPersistence().removeByCompanyId(companyId);
}
/**
* Returns the number of audit events where companyId = ?.
*
* @param companyId the company ID
* @return the number of matching audit events
*/
public static int countByCompanyId(long companyId) {
return getPersistence().countByCompanyId(companyId);
}
/**
* Caches the audit event in the entity cache if it is enabled.
*
* @param auditEvent the audit event
*/
public static void cacheResult(AuditEvent auditEvent) {
getPersistence().cacheResult(auditEvent);
}
/**
* Caches the audit events in the entity cache if it is enabled.
*
* @param auditEvents the audit events
*/
public static void cacheResult(List auditEvents) {
getPersistence().cacheResult(auditEvents);
}
/**
* Creates a new audit event with the primary key. Does not add the audit event to the database.
*
* @param auditEventId the primary key for the new audit event
* @return the new audit event
*/
public static AuditEvent create(long auditEventId) {
return getPersistence().create(auditEventId);
}
/**
* Removes the audit event with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param auditEventId the primary key of the audit event
* @return the audit event that was removed
* @throws NoSuchEventException if a audit event with the primary key could not be found
*/
public static AuditEvent remove(long auditEventId)
throws com.liferay.portal.security.audit.storage.exception.
NoSuchEventException {
return getPersistence().remove(auditEventId);
}
public static AuditEvent updateImpl(AuditEvent auditEvent) {
return getPersistence().updateImpl(auditEvent);
}
/**
* Returns the audit event with the primary key or throws a NoSuchEventException if it could not be found.
*
* @param auditEventId the primary key of the audit event
* @return the audit event
* @throws NoSuchEventException if a audit event with the primary key could not be found
*/
public static AuditEvent findByPrimaryKey(long auditEventId)
throws com.liferay.portal.security.audit.storage.exception.
NoSuchEventException {
return getPersistence().findByPrimaryKey(auditEventId);
}
/**
* Returns the audit event with the primary key or returns null if it could not be found.
*
* @param auditEventId the primary key of the audit event
* @return the audit event, or null if a audit event with the primary key could not be found
*/
public static AuditEvent fetchByPrimaryKey(long auditEventId) {
return getPersistence().fetchByPrimaryKey(auditEventId);
}
/**
* Returns all the audit events.
*
* @return the audit events
*/
public static List findAll() {
return getPersistence().findAll();
}
/**
* 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 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 and pagination is required (start and end are not QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from AuditEventModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
*
*
* @param start the lower bound of the range of audit events
* @param end the upper bound of the range of audit events (not inclusive)
* @return the range of audit events
*/
public static List findAll(int start, int end) {
return getPersistence().findAll(start, end);
}
/**
* Returns an ordered 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 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 and pagination is required (start and end are not QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from AuditEventModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
*
*
* @param start the lower bound of the range of audit events
* @param end the upper bound of the range of audit events (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of audit events
*/
public static List findAll(
int start, int end, OrderByComparator orderByComparator) {
return getPersistence().findAll(start, end, orderByComparator);
}
/**
* Returns an ordered 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 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 and pagination is required (start and end are not QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from AuditEventModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
*
*
* @param start the lower bound of the range of audit events
* @param end the upper bound of the range of audit events (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @param retrieveFromCache whether to retrieve from the finder cache
* @return the ordered range of audit events
*/
public static List findAll(
int start, int end, OrderByComparator orderByComparator,
boolean retrieveFromCache) {
return getPersistence().findAll(
start, end, orderByComparator, retrieveFromCache);
}
/**
* Removes all the audit events from the database.
*/
public static void removeAll() {
getPersistence().removeAll();
}
/**
* Returns the number of audit events.
*
* @return the number of audit events
*/
public static int countAll() {
return getPersistence().countAll();
}
public static AuditEventPersistence getPersistence() {
return _serviceTracker.getService();
}
private static ServiceTracker
_serviceTracker;
static {
Bundle bundle = FrameworkUtil.getBundle(AuditEventPersistence.class);
ServiceTracker
serviceTracker =
new ServiceTracker
(
bundle.getBundleContext(), AuditEventPersistence.class,
null);
serviceTracker.open();
_serviceTracker = serviceTracker;
}
}