com.liferay.portal.kernel.service

Class SystemEventLocalServiceUtil

java.lang.Object

com.liferay.portal.kernel.service.SystemEventLocalServiceUtil

public class SystemEventLocalServiceUtil
extends java.lang.Object

Provides the local service utility for SystemEvent. This utility wraps com.liferay.portal.service.impl.SystemEventLocalServiceImpl and is an access point for service operations in application layer code running on the local server. 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:

SystemEventLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
SystemEventLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static SystemEvent	addSystemEvent(long userId, long groupId, java.lang.String className, long classPK, java.lang.String classUuid, java.lang.String referrerClassName, int type, java.lang.String extraData)
static SystemEvent	addSystemEvent(long companyId, java.lang.String className, long classPK, java.lang.String classUuid, java.lang.String referrerClassName, int type, java.lang.String extraData)
static SystemEvent	addSystemEvent(SystemEvent systemEvent) Adds the system event to the database.
static void	checkSystemEvents()
static PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
static SystemEvent	createSystemEvent(long systemEventId) Creates a new system event with the primary key.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static SystemEvent	deleteSystemEvent(long systemEventId) Deletes the system event with the primary key from the database.
static SystemEvent	deleteSystemEvent(SystemEvent systemEvent) Deletes the system event from the database.
static void	deleteSystemEvents(long groupId)
static void	deleteSystemEvents(long groupId, long systemEventSetKey)
static <T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static int	dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static <T> java.util.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.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static SystemEvent	fetchSystemEvent(long systemEventId)
static SystemEvent	fetchSystemEvent(long groupId, long classNameId, long classPK, int type)
static ActionableDynamicQuery	getActionableDynamicQuery()
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static SystemEventLocalService	getService()
static SystemEvent	getSystemEvent(long systemEventId) Returns the system event with the primary key.
static java.util.List<SystemEvent>	getSystemEvents(int start, int end) Returns a range of all the system events.
static java.util.List<SystemEvent>	getSystemEvents(long groupId, long classNameId, long classPK)
static java.util.List<SystemEvent>	getSystemEvents(long groupId, long classNameId, long classPK, int type)
static int	getSystemEventsCount() Returns the number of system events.
static SystemEvent	updateSystemEvent(SystemEvent systemEvent) Updates the system event in the database or adds it if it does not yet exist.
static boolean	validateGroup(long groupId)

Methods inherited from class java.lang.Object

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

Constructor Detail

SystemEventLocalServiceUtil

public SystemEventLocalServiceUtil()

Method Detail

addSystemEvent

public static SystemEvent addSystemEvent(long userId,
                                         long groupId,
                                         java.lang.String className,
                                         long classPK,
                                         java.lang.String classUuid,
                                         java.lang.String referrerClassName,
                                         int type,
                                         java.lang.String extraData)
                                  throws PortalException

Throws:

PortalException

addSystemEvent

public static SystemEvent addSystemEvent(long companyId,
                                         java.lang.String className,
                                         long classPK,
                                         java.lang.String classUuid,
                                         java.lang.String referrerClassName,
                                         int type,
                                         java.lang.String extraData)
                                  throws PortalException

Throws:

PortalException

addSystemEvent

public static 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

public static void checkSystemEvents()
                              throws PortalException

Throws:

PortalException

createPersistedModel

public static PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                                           throws PortalException

Throws:

PortalException

createSystemEvent

public static 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

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

deleteSystemEvent

public static 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

public static 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

public static void deleteSystemEvents(long groupId)

deleteSystemEvents

public static void deleteSystemEvents(long groupId,
                                      long systemEventSetKey)

dslQuery

public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dslQueryCount

public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> java.util.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

public static <T> java.util.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

public static <T> java.util.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

public static 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

public static 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

public static SystemEvent fetchSystemEvent(long systemEventId)

fetchSystemEvent

public static SystemEvent fetchSystemEvent(long groupId,
                                           long classNameId,
                                           long classPK,
                                           int type)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

getSystemEvent

public static 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

public static java.util.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

public static java.util.List<SystemEvent> getSystemEvents(long groupId,
                                                          long classNameId,
                                                          long classPK)

getSystemEvents

public static java.util.List<SystemEvent> getSystemEvents(long groupId,
                                                          long classNameId,
                                                          long classPK,
                                                          int type)

getSystemEventsCount

public static int getSystemEventsCount()

Returns the number of system events.

Returns:

the number of system events

updateSystemEvent

public static 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

public static boolean validateGroup(long groupId)
                             throws PortalException

Throws:

PortalException

getService

public static SystemEventLocalService getService()