Class SystemEventLocalServiceUtil
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:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic SystemEvent
addSystemEvent
(long userId, long groupId, String className, long classPK, String classUuid, String referrerClassName, int type, String extraData) static SystemEvent
addSystemEvent
(long companyId, String className, long classPK, String classUuid, String referrerClassName, int type, String extraData) static SystemEvent
addSystemEvent
(SystemEvent systemEvent) Adds the system event to the database.static void
static PersistedModel
createPersistedModel
(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
static <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <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.static <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.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
static String
Returns the OSGi service identifier.static PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static SystemEventLocalService
static SystemEvent
getSystemEvent
(long systemEventId) Returns the system event with the primary key.static List<SystemEvent>
getSystemEvents
(int start, int end) Returns a range of all the system events.static List<SystemEvent>
getSystemEvents
(long groupId, long classNameId, long classPK) static List<SystemEvent>
getSystemEvents
(long groupId, long classNameId, long classPK, int type) static int
Returns the number of system events.static void
setService
(SystemEventLocalService service) 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)
-
Constructor Details
-
SystemEventLocalServiceUtil
public SystemEventLocalServiceUtil()
-
-
Method Details
-
addSystemEvent
public static SystemEvent addSystemEvent(long userId, long groupId, String className, long classPK, String classUuid, String referrerClassName, int type, String extraData) throws PortalException - Throws:
PortalException
-
addSystemEvent
public static 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
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - 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
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException - 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
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
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
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
public static <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
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
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
-
fetchSystemEvent
-
getActionableDynamicQuery
-
getIndexableActionableDynamicQuery
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
getSystemEvent
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
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
-
getSystemEvents
public static 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
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
-
getService
-
setService
-