Interface SystemEventLocalService
- All Superinterfaces:
BaseLocalService
,CTService<SystemEvent>
,PersistedModelLocalService
- All Known Implementing Classes:
SystemEventLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddSystemEvent
(long userId, long groupId, String className, long classPK, String classUuid, String referrerClassName, int type, String extraData) addSystemEvent
(long companyId, String className, long classPK, String classUuid, String referrerClassName, int type, String extraData) addSystemEvent
(SystemEvent systemEvent) Adds the system event to the database.void
createPersistedModel
(Serializable primaryKeyObj) createSystemEvent
(long systemEventId) Creates a new system event with the primary key.deletePersistedModel
(PersistedModel persistedModel) deleteSystemEvent
(long systemEventId) Deletes the system event with the primary key from the database.deleteSystemEvent
(SystemEvent systemEvent) Deletes the system event from the database.void
deleteSystemEvents
(long groupId) void
deleteSystemEvents
(long groupId, long systemEventSetKey) <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) <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.fetchSystemEvent
(long systemEventId) fetchSystemEvent
(long groupId, long classNameId, long classPK, int type) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) getSystemEvent
(long systemEventId) Returns the system event with the primary key.getSystemEvents
(int start, int end) Returns a range of all the system events.getSystemEvents
(long groupId, long classNameId, long classPK) getSystemEvents
(long groupId, long classNameId, long classPK, int type) int
Returns the number of system events.updateSystemEvent
(SystemEvent systemEvent) Updates the system event in the database or adds it if it does not yet exist.<R,
E extends Throwable>
RupdateWithUnsafeFunction
(com.liferay.petra.function.UnsafeFunction<CTPersistence<SystemEvent>, R, E> updateUnsafeFunction) boolean
validateGroup
(long groupId) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
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
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
- Throws:
PortalException
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
createSystemEvent
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
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deleteSystemEvent
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
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
void deleteSystemEvents(long groupId) -
deleteSystemEvents
void deleteSystemEvents(long groupId, long systemEventSetKey) -
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacePersistedModelLocalService
-
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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.SystemEventModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.SystemEventModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- 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 queryprojection
- 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 interfacePersistedModelLocalService
- 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.SystemEventModelImpl
.- Parameters:
start
- the lower bound of the range of system eventsend
- 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
Returns the number of system events.- Returns:
- the number of system events
-
updateSystemEvent
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
- Throws:
PortalException
-
getCTPersistence
- Specified by:
getCTPersistence
in interfaceCTService<SystemEvent>
-
getModelClass
- Specified by:
getModelClass
in interfaceCTService<SystemEvent>
-
updateWithUnsafeFunction
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<SystemEvent>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunction
in interfaceCTService<SystemEvent>
- Throws:
E extends Throwable
-