com.liferay.portal.kernel.service

Interface SystemEventLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

SystemEventLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface SystemEventLocalService
extends BaseLocalService, 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:

SystemEventLocalServiceUtil, SystemEventLocalServiceBaseImpl, SystemEventLocalServiceImpl

{$generated.description}

Method Summary

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

Method Detail

addSystemEvent

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

Throws:

PortalException

addSystemEvent

SystemEvent addSystemEvent(long companyId,
                           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.

Parameters:

systemEvent - the system event

Returns:

the system event that was added

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.

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.

Parameters:

systemEvent - the system event

Returns:

the system event that was removed

deleteSystemEvents

void deleteSystemEvents(long groupId)

deleteSystemEvents

void deleteSystemEvents(long groupId,
                        long systemEventSetKey)

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 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 SystemEventModelImpl. 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:

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 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 SystemEventModelImpl. 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:

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 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 SystemEventModelImpl. 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 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.

Parameters:

systemEvent - the system event

Returns:

the system event that was updated