com.liferay.portal.security.audit.storage.service.persistence

Class AuditEventUtil

java.lang.Object

com.liferay.portal.security.audit.storage.service.persistence.AuditEventUtil

@ProviderType
public class AuditEventUtil
extends java.lang.Object

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

See Also:

AuditEventPersistence, com.liferay.portal.security.audit.storage.service.persistence.impl.AuditEventPersistenceImpl

Generated:

Constructor Summary

Constructors

Constructor and Description
AuditEventUtil()

Method Summary

Modifier and Type	Method and Description
static void	cacheResult(AuditEvent auditEvent) Caches the audit event in the entity cache if it is enabled.
static void	cacheResult(java.util.List<AuditEvent> auditEvents) Caches the audit events in the entity cache if it is enabled.
static void	clearCache()
static void	clearCache(AuditEvent auditEvent)
static int	countAll() Returns the number of audit events.
static int	countByCompanyId(long companyId) Returns the number of audit events where companyId = ?.
static long	countWithDynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
static AuditEvent	create(long auditEventId) Creates a new audit event with the primary key.
static AuditEvent	fetchByCompanyId_First(long companyId, com.liferay.portal.kernel.util.OrderByComparator<AuditEvent> orderByComparator) Returns the first audit event in the ordered set where companyId = ?.
static AuditEvent	fetchByCompanyId_Last(long companyId, com.liferay.portal.kernel.util.OrderByComparator<AuditEvent> orderByComparator) Returns the last audit event in the ordered set where companyId = ?.
static AuditEvent	fetchByPrimaryKey(long auditEventId) Returns the audit event with the primary key or returns null if it could not be found.
static java.util.Map<java.io.Serializable,AuditEvent>	fetchByPrimaryKeys(java.util.Set<java.io.Serializable> primaryKeys)
static java.util.List<AuditEvent>	findAll() Returns all the audit events.
static java.util.List<AuditEvent>	findAll(int start, int end) Returns a range of all the audit events.
static java.util.List<AuditEvent>	findAll(int start, int end, com.liferay.portal.kernel.util.OrderByComparator<AuditEvent> orderByComparator) Returns an ordered range of all the audit events.
static java.util.List<AuditEvent>	findAll(int start, int end, com.liferay.portal.kernel.util.OrderByComparator<AuditEvent> orderByComparator, boolean retrieveFromCache) Returns an ordered range of all the audit events.
static AuditEvent	findByCompanyId_First(long companyId, com.liferay.portal.kernel.util.OrderByComparator<AuditEvent> orderByComparator) Returns the first audit event in the ordered set where companyId = ?.
static AuditEvent	findByCompanyId_Last(long companyId, com.liferay.portal.kernel.util.OrderByComparator<AuditEvent> orderByComparator) Returns the last audit event in the ordered set where companyId = ?.
static AuditEvent[]	findByCompanyId_PrevAndNext(long auditEventId, long companyId, com.liferay.portal.kernel.util.OrderByComparator<AuditEvent> orderByComparator) Returns the audit events before and after the current audit event in the ordered set where companyId = ?.
static java.util.List<AuditEvent>	findByCompanyId(long companyId) Returns all the audit events where companyId = ?.
static java.util.List<AuditEvent>	findByCompanyId(long companyId, int start, int end) Returns a range of all the audit events where companyId = ?.
static java.util.List<AuditEvent>	findByCompanyId(long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<AuditEvent> orderByComparator) Returns an ordered range of all the audit events where companyId = ?.
static java.util.List<AuditEvent>	findByCompanyId(long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<AuditEvent> orderByComparator, boolean retrieveFromCache) Returns an ordered range of all the audit events where companyId = ?.
static AuditEvent	findByPrimaryKey(long auditEventId) Returns the audit event with the primary key or throws a NoSuchEventException if it could not be found.
static java.util.List<AuditEvent>	findWithDynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
static java.util.List<AuditEvent>	findWithDynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end)
static java.util.List<AuditEvent>	findWithDynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<AuditEvent> orderByComparator)
static AuditEventPersistence	getPersistence()
static AuditEvent	remove(long auditEventId) Removes the audit event with the primary key from the database.
static void	removeAll() Removes all the audit events from the database.
static void	removeByCompanyId(long companyId) Removes all the audit events where companyId = ? from the database.
static AuditEvent	update(AuditEvent auditEvent)
static AuditEvent	update(AuditEvent auditEvent, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static AuditEvent	updateImpl(AuditEvent auditEvent)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuditEventUtil

public AuditEventUtil()

Method Detail

clearCache

public static void clearCache()

See Also:

BasePersistence.clearCache()

clearCache

public static void clearCache(AuditEvent auditEvent)

See Also:

BasePersistence.clearCache(com.liferay.portal.kernel.model.BaseModel)

countWithDynamicQuery

public static long countWithDynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)

See Also:

BasePersistence.countWithDynamicQuery(DynamicQuery)

findWithDynamicQuery

public static java.util.List<AuditEvent> findWithDynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)

See Also:

BasePersistence.findWithDynamicQuery(DynamicQuery)

findWithDynamicQuery

public static java.util.List<AuditEvent> findWithDynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                              int start,
                                                              int end)

See Also:

BasePersistence.findWithDynamicQuery(DynamicQuery, int, int)

findWithDynamicQuery

public static java.util.List<AuditEvent> findWithDynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                              int start,
                                                              int end,
                                                              com.liferay.portal.kernel.util.OrderByComparator<AuditEvent> orderByComparator)

See Also:

BasePersistence.findWithDynamicQuery(DynamicQuery, int, int, OrderByComparator)

update

public static AuditEvent update(AuditEvent auditEvent)

See Also:

BasePersistence.update(com.liferay.portal.kernel.model.BaseModel)

update

public static AuditEvent update(AuditEvent auditEvent,
                                com.liferay.portal.kernel.service.ServiceContext serviceContext)

See Also:

BasePersistence.update(com.liferay.portal.kernel.model.BaseModel, ServiceContext)

findByCompanyId

public static java.util.List<AuditEvent> findByCompanyId(long companyId)

Returns all the audit events where companyId = ?.

Parameters:

companyId - the company ID

Returns:

the matching audit events

findByCompanyId

public static java.util.List<AuditEvent> findByCompanyId(long companyId,
                                                         int start,
                                                         int end)

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.

Parameters:

companyId - the company ID

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 matching audit events

findByCompanyId

public static java.util.List<AuditEvent> findByCompanyId(long companyId,
                                                         int start,
                                                         int end,
                                                         com.liferay.portal.kernel.util.OrderByComparator<AuditEvent> 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.

Parameters:

companyId - the company ID

start - the lower bound of the range of audit events

end - the upper bound of the range of audit events (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching audit events

findByCompanyId

public static java.util.List<AuditEvent> findByCompanyId(long companyId,
                                                         int start,
                                                         int end,
                                                         com.liferay.portal.kernel.util.OrderByComparator<AuditEvent> orderByComparator,
                                                         boolean retrieveFromCache)

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.

Parameters:

companyId - the company ID

start - the lower bound of the range of audit events

end - the upper bound of the range of audit events (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

retrieveFromCache - whether to retrieve from the finder cache

Returns:

the ordered range of matching audit events

findByCompanyId_First

public static AuditEvent findByCompanyId_First(long companyId,
                                               com.liferay.portal.kernel.util.OrderByComparator<AuditEvent> orderByComparator)
                                        throws NoSuchEventException

Returns the first audit event in the ordered set where companyId = ?.

Parameters:

companyId - the company ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the first matching audit event

Throws:

NoSuchEventException - if a matching audit event could not be found

fetchByCompanyId_First

public static AuditEvent fetchByCompanyId_First(long companyId,
                                                com.liferay.portal.kernel.util.OrderByComparator<AuditEvent> orderByComparator)

Returns the first audit event in the ordered set where companyId = ?.

Parameters:

companyId - the company ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the first matching audit event, or null if a matching audit event could not be found

findByCompanyId_Last

public static AuditEvent findByCompanyId_Last(long companyId,
                                              com.liferay.portal.kernel.util.OrderByComparator<AuditEvent> orderByComparator)
                                       throws NoSuchEventException

Returns the last audit event in the ordered set where companyId = ?.

Parameters:

companyId - the company ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the last matching audit event

Throws:

NoSuchEventException - if a matching audit event could not be found

fetchByCompanyId_Last

public static AuditEvent fetchByCompanyId_Last(long companyId,
                                               com.liferay.portal.kernel.util.OrderByComparator<AuditEvent> orderByComparator)

Returns the last audit event in the ordered set where companyId = ?.

Parameters:

companyId - the company ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the last matching audit event, or null if a matching audit event could not be found

findByCompanyId_PrevAndNext

public static AuditEvent[] findByCompanyId_PrevAndNext(long auditEventId,
                                                       long companyId,
                                                       com.liferay.portal.kernel.util.OrderByComparator<AuditEvent> orderByComparator)
                                                throws NoSuchEventException

Returns the audit events before and after the current audit event in the ordered set where companyId = ?.

Parameters:

auditEventId - the primary key of the current audit event

companyId - the company ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the previous, current, and next audit event

Throws:

NoSuchEventException - if a audit event with the primary key could not be found

removeByCompanyId

public static void removeByCompanyId(long companyId)

Removes all the audit events where companyId = ? from the database.

Parameters:

companyId - the company ID

countByCompanyId

public static int countByCompanyId(long companyId)

Returns the number of audit events where companyId = ?.

Parameters:

companyId - the company ID

Returns:

the number of matching audit events

cacheResult

public static void cacheResult(AuditEvent auditEvent)

Caches the audit event in the entity cache if it is enabled.

Parameters:

auditEvent - the audit event

cacheResult

public static void cacheResult(java.util.List<AuditEvent> auditEvents)

Caches the audit events in the entity cache if it is enabled.

Parameters:

auditEvents - the audit events

create

public static AuditEvent create(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

remove

public static AuditEvent remove(long auditEventId)
                         throws NoSuchEventException

Removes the audit event with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

auditEventId - the primary key of the audit event

Returns:

the audit event that was removed

Throws:

NoSuchEventException - if a audit event with the primary key could not be found

updateImpl

public static AuditEvent updateImpl(AuditEvent auditEvent)

findByPrimaryKey

public static AuditEvent findByPrimaryKey(long auditEventId)
                                   throws NoSuchEventException

Returns the audit event with the primary key or throws a NoSuchEventException if it could not be found.

Parameters:

auditEventId - the primary key of the audit event

Returns:

the audit event

Throws:

NoSuchEventException - if a audit event with the primary key could not be found

fetchByPrimaryKey

public static AuditEvent fetchByPrimaryKey(long auditEventId)

Returns the audit event with the primary key or returns null if it could not be found.

Parameters:

auditEventId - the primary key of the audit event

Returns:

the audit event, or null if a audit event with the primary key could not be found

fetchByPrimaryKeys

public static java.util.Map<java.io.Serializable,AuditEvent> fetchByPrimaryKeys(java.util.Set<java.io.Serializable> primaryKeys)

findAll

public static java.util.List<AuditEvent> findAll()

Returns all the audit events.

Returns:

the audit events

findAll

public static java.util.List<AuditEvent> findAll(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 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.

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

findAll

public static java.util.List<AuditEvent> findAll(int start,
                                                 int end,
                                                 com.liferay.portal.kernel.util.OrderByComparator<AuditEvent> 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.

Parameters:

start - the lower bound of the range of audit events

end - the upper bound of the range of audit events (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of audit events

findAll

public static java.util.List<AuditEvent> findAll(int start,
                                                 int end,
                                                 com.liferay.portal.kernel.util.OrderByComparator<AuditEvent> orderByComparator,
                                                 boolean retrieveFromCache)

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.

Parameters:

start - the lower bound of the range of audit events

end - the upper bound of the range of audit events (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

retrieveFromCache - whether to retrieve from the finder cache

Returns:

the ordered range of audit events

removeAll

public static void removeAll()

Removes all the audit events from the database.

countAll

public static int countAll()

Returns the number of audit events.

Returns:

the number of audit events

getPersistence

public static AuditEventPersistence getPersistence()