public class UserNotificationEventLocalServiceUtil
extends java.lang.Object
com.liferay.portal.service.impl.UserNotificationEventLocalServiceImpl 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.UserNotificationEventLocalService| Constructor and Description |
|---|
UserNotificationEventLocalServiceUtil() |
| Modifier and Type | Method and Description |
|---|---|
static UserNotificationEvent |
addUserNotificationEvent(long userId,
boolean actionRequired,
NotificationEvent notificationEvent) |
static UserNotificationEvent |
addUserNotificationEvent(long userId,
NotificationEvent notificationEvent) |
static UserNotificationEvent |
addUserNotificationEvent(long userId,
java.lang.String type,
long timestamp,
int deliveryType,
long deliverBy,
java.lang.String payload,
boolean actionRequired,
boolean archived,
ServiceContext serviceContext) |
static UserNotificationEvent |
addUserNotificationEvent(long userId,
java.lang.String type,
long timestamp,
int deliveryType,
long deliverBy,
java.lang.String payload,
boolean archived,
ServiceContext serviceContext) |
static UserNotificationEvent |
addUserNotificationEvent(long userId,
java.lang.String type,
long timestamp,
long deliverBy,
java.lang.String payload,
boolean archived,
ServiceContext serviceContext)
Deprecated.
As of Wilberforce (7.0.x),
addUserNotificationEvent(long, String, long, int, long,
String, boolean, ServiceContext) |
static UserNotificationEvent |
addUserNotificationEvent(UserNotificationEvent userNotificationEvent)
Adds the user notification event to the database.
|
static java.util.List<UserNotificationEvent> |
addUserNotificationEvents(long userId,
java.util.Collection<NotificationEvent> notificationEvents) |
static void |
archiveUserNotificationEvents(long userId,
int deliveryType,
boolean actionRequired) |
static UserNotificationEvent |
createUserNotificationEvent(long userNotificationEventId)
Creates a new user notification event with the primary key.
|
static PersistedModel |
deletePersistedModel(PersistedModel persistedModel) |
static UserNotificationEvent |
deleteUserNotificationEvent(long userNotificationEventId)
Deletes the user notification event with the primary key from the database.
|
static void |
deleteUserNotificationEvent(java.lang.String uuid,
long companyId) |
static UserNotificationEvent |
deleteUserNotificationEvent(UserNotificationEvent userNotificationEvent)
Deletes the user notification event from the database.
|
static void |
deleteUserNotificationEvents(java.util.Collection<java.lang.String> uuids,
long companyId) |
static void |
deleteUserNotificationEvents(long userId) |
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 UserNotificationEvent |
fetchUserNotificationEvent(long userNotificationEventId) |
static UserNotificationEvent |
fetchUserNotificationEventByUuidAndCompanyId(java.lang.String uuid,
long companyId)
Returns the user notification event with the matching UUID and company.
|
static ActionableDynamicQuery |
getActionableDynamicQuery() |
static java.util.List<UserNotificationEvent> |
getArchivedUserNotificationEvents(long userId,
boolean archived) |
static java.util.List<UserNotificationEvent> |
getArchivedUserNotificationEvents(long userId,
boolean actionRequired,
boolean archived) |
static java.util.List<UserNotificationEvent> |
getArchivedUserNotificationEvents(long userId,
boolean actionRequired,
boolean archived,
int start,
int end) |
static java.util.List<UserNotificationEvent> |
getArchivedUserNotificationEvents(long userId,
boolean archived,
int start,
int end) |
static java.util.List<UserNotificationEvent> |
getArchivedUserNotificationEvents(long userId,
int deliveryType,
boolean archived) |
static java.util.List<UserNotificationEvent> |
getArchivedUserNotificationEvents(long userId,
int deliveryType,
boolean actionRequired,
boolean archived) |
static java.util.List<UserNotificationEvent> |
getArchivedUserNotificationEvents(long userId,
int deliveryType,
boolean actionRequired,
boolean archived,
int start,
int end) |
static java.util.List<UserNotificationEvent> |
getArchivedUserNotificationEvents(long userId,
int deliveryType,
boolean actionRequired,
boolean archived,
int start,
int end,
OrderByComparator<UserNotificationEvent> obc) |
static java.util.List<UserNotificationEvent> |
getArchivedUserNotificationEvents(long userId,
int deliveryType,
boolean archived,
int start,
int end) |
static int |
getArchivedUserNotificationEventsCount(long userId,
boolean archived) |
static int |
getArchivedUserNotificationEventsCount(long userId,
boolean actionRequired,
boolean archived) |
static int |
getArchivedUserNotificationEventsCount(long userId,
int deliveryType,
boolean archived) |
static int |
getArchivedUserNotificationEventsCount(long userId,
int deliveryType,
boolean actionRequired,
boolean archived) |
static java.util.List<UserNotificationEvent> |
getDeliveredUserNotificationEvents(long userId,
boolean delivered) |
static java.util.List<UserNotificationEvent> |
getDeliveredUserNotificationEvents(long userId,
boolean delivered,
boolean actionRequired) |
static java.util.List<UserNotificationEvent> |
getDeliveredUserNotificationEvents(long userId,
boolean delivered,
boolean actionRequired,
int start,
int end) |
static java.util.List<UserNotificationEvent> |
getDeliveredUserNotificationEvents(long userId,
boolean delivered,
int start,
int end) |
static java.util.List<UserNotificationEvent> |
getDeliveredUserNotificationEvents(long userId,
int deliveryType,
boolean delivered) |
static java.util.List<UserNotificationEvent> |
getDeliveredUserNotificationEvents(long userId,
int deliveryType,
boolean delivered,
boolean actionRequired) |
static java.util.List<UserNotificationEvent> |
getDeliveredUserNotificationEvents(long userId,
int deliveryType,
boolean delivered,
boolean actionRequired,
int start,
int end) |
static java.util.List<UserNotificationEvent> |
getDeliveredUserNotificationEvents(long userId,
int deliveryType,
boolean delivered,
boolean actionRequired,
int start,
int end,
OrderByComparator<UserNotificationEvent> obc) |
static java.util.List<UserNotificationEvent> |
getDeliveredUserNotificationEvents(long userId,
int deliveryType,
boolean delivered,
int start,
int end) |
static int |
getDeliveredUserNotificationEventsCount(long userId,
boolean delivered) |
static int |
getDeliveredUserNotificationEventsCount(long userId,
boolean delivered,
boolean actionRequired) |
static int |
getDeliveredUserNotificationEventsCount(long userId,
int deliveryType,
boolean delivered) |
static int |
getDeliveredUserNotificationEventsCount(long userId,
int deliveryType,
boolean delivered,
boolean actionRequired) |
static IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
static java.lang.String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static PersistedModel |
getPersistedModel(java.io.Serializable primaryKeyObj) |
static UserNotificationEventLocalService |
getService() |
static java.util.List<UserNotificationEvent> |
getTypeNotificationEvents(java.lang.String type) |
static UserNotificationEvent |
getUserNotificationEvent(long userNotificationEventId)
Returns the user notification event with the primary key.
|
static UserNotificationEvent |
getUserNotificationEventByUuidAndCompanyId(java.lang.String uuid,
long companyId)
Returns the user notification event with the matching UUID and company.
|
static java.util.List<UserNotificationEvent> |
getUserNotificationEvents(int start,
int end)
Returns a range of all the user notification events.
|
static java.util.List<UserNotificationEvent> |
getUserNotificationEvents(long userId) |
static java.util.List<UserNotificationEvent> |
getUserNotificationEvents(long userId,
int deliveryType) |
static java.util.List<UserNotificationEvent> |
getUserNotificationEvents(long userId,
int start,
int end) |
static java.util.List<UserNotificationEvent> |
getUserNotificationEvents(long userId,
int deliveryType,
int start,
int end) |
static int |
getUserNotificationEventsCount()
Returns the number of user notification events.
|
static int |
getUserNotificationEventsCount(long userId) |
static int |
getUserNotificationEventsCount(long userId,
int deliveryType) |
static int |
getUserNotificationEventsCount(long userId,
java.lang.String type,
int deliveryType,
boolean archived) |
static UserNotificationEvent |
sendUserNotificationEvents(long userId,
java.lang.String portletId,
int deliveryType,
boolean actionRequired,
JSONObject notificationEventJSONObject) |
static UserNotificationEvent |
sendUserNotificationEvents(long userId,
java.lang.String portletId,
int deliveryType,
JSONObject notificationEventJSONObject) |
static UserNotificationEvent |
updateUserNotificationEvent(java.lang.String uuid,
long companyId,
boolean archive) |
static UserNotificationEvent |
updateUserNotificationEvent(UserNotificationEvent userNotificationEvent)
Updates the user notification event in the database or adds it if it does not yet exist.
|
static java.util.List<UserNotificationEvent> |
updateUserNotificationEvents(java.util.Collection<java.lang.String> uuids,
long companyId,
boolean archive) |
public UserNotificationEventLocalServiceUtil()
public static UserNotificationEvent addUserNotificationEvent(long userId, boolean actionRequired, NotificationEvent notificationEvent) throws PortalException
PortalExceptionpublic static UserNotificationEvent addUserNotificationEvent(long userId, NotificationEvent notificationEvent) throws PortalException
PortalExceptionpublic static UserNotificationEvent addUserNotificationEvent(long userId, java.lang.String type, long timestamp, int deliveryType, long deliverBy, java.lang.String payload, boolean actionRequired, boolean archived, ServiceContext serviceContext) throws PortalException
PortalExceptionpublic static UserNotificationEvent addUserNotificationEvent(long userId, java.lang.String type, long timestamp, int deliveryType, long deliverBy, java.lang.String payload, boolean archived, ServiceContext serviceContext) throws PortalException
PortalException@Deprecated public static UserNotificationEvent addUserNotificationEvent(long userId, java.lang.String type, long timestamp, long deliverBy, java.lang.String payload, boolean archived, ServiceContext serviceContext) throws PortalException
addUserNotificationEvent(long, String, long, int, long,
String, boolean, ServiceContext)PortalExceptionpublic static UserNotificationEvent addUserNotificationEvent(UserNotificationEvent userNotificationEvent)
userNotificationEvent - the user notification eventpublic static java.util.List<UserNotificationEvent> addUserNotificationEvents(long userId, java.util.Collection<NotificationEvent> notificationEvents) throws PortalException
PortalExceptionpublic static void archiveUserNotificationEvents(long userId,
int deliveryType,
boolean actionRequired)
throws PortalException
PortalExceptionpublic static UserNotificationEvent createUserNotificationEvent(long userNotificationEventId)
userNotificationEventId - the primary key for the new user notification eventpublic static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
PortalExceptionpublic static UserNotificationEvent deleteUserNotificationEvent(long userNotificationEventId) throws PortalException
userNotificationEventId - the primary key of the user notification eventPortalException - if a user notification event with the primary key could not be foundpublic static void deleteUserNotificationEvent(java.lang.String uuid,
long companyId)
public static UserNotificationEvent deleteUserNotificationEvent(UserNotificationEvent userNotificationEvent)
userNotificationEvent - the user notification eventpublic static void deleteUserNotificationEvents(java.util.Collection<java.lang.String> uuids,
long companyId)
public static void deleteUserNotificationEvents(long userId)
public static DynamicQuery dynamicQuery()
public static <T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic querypublic static <T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
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.UserNotificationEventModelImpl.
dynamicQuery - the dynamic querystart - the lower bound of the range of model instancesend - the upper bound of the range of model instances (not inclusive)public static <T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)
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.UserNotificationEventModelImpl.
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 (optionally null)public static long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic querypublic static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
dynamicQuery - the dynamic queryprojection - the projection to apply to the querypublic static UserNotificationEvent fetchUserNotificationEvent(long userNotificationEventId)
public static UserNotificationEvent fetchUserNotificationEventByUuidAndCompanyId(java.lang.String uuid, long companyId)
uuid - the user notification event's UUIDcompanyId - the primary key of the companynull if a matching user notification event could not be foundpublic static ActionableDynamicQuery getActionableDynamicQuery()
public static java.util.List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId, boolean archived)
public static java.util.List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId, boolean actionRequired, boolean archived)
public static java.util.List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId, boolean actionRequired, boolean archived, int start, int end)
public static java.util.List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId, boolean archived, int start, int end)
public static java.util.List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId, int deliveryType, boolean archived)
public static java.util.List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId, int deliveryType, boolean actionRequired, boolean archived)
public static java.util.List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId, int deliveryType, boolean actionRequired, boolean archived, int start, int end)
public static java.util.List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId, int deliveryType, boolean actionRequired, boolean archived, int start, int end, OrderByComparator<UserNotificationEvent> obc)
public static java.util.List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId, int deliveryType, boolean archived, int start, int end)
public static int getArchivedUserNotificationEventsCount(long userId,
boolean archived)
public static int getArchivedUserNotificationEventsCount(long userId,
boolean actionRequired,
boolean archived)
public static int getArchivedUserNotificationEventsCount(long userId,
int deliveryType,
boolean archived)
public static int getArchivedUserNotificationEventsCount(long userId,
int deliveryType,
boolean actionRequired,
boolean archived)
public static java.util.List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId, boolean delivered)
public static java.util.List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId, boolean delivered, boolean actionRequired)
public static java.util.List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId, boolean delivered, boolean actionRequired, int start, int end)
public static java.util.List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId, boolean delivered, int start, int end)
public static java.util.List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId, int deliveryType, boolean delivered)
public static java.util.List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId, int deliveryType, boolean delivered, boolean actionRequired)
public static java.util.List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId, int deliveryType, boolean delivered, boolean actionRequired, int start, int end)
public static java.util.List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId, int deliveryType, boolean delivered, boolean actionRequired, int start, int end, OrderByComparator<UserNotificationEvent> obc)
public static java.util.List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId, int deliveryType, boolean delivered, int start, int end)
public static int getDeliveredUserNotificationEventsCount(long userId,
boolean delivered)
public static int getDeliveredUserNotificationEventsCount(long userId,
boolean delivered,
boolean actionRequired)
public static int getDeliveredUserNotificationEventsCount(long userId,
int deliveryType,
boolean delivered)
public static int getDeliveredUserNotificationEventsCount(long userId,
int deliveryType,
boolean delivered,
boolean actionRequired)
public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static java.lang.String getOSGiServiceIdentifier()
public static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj) throws PortalException
PortalExceptionpublic static java.util.List<UserNotificationEvent> getTypeNotificationEvents(java.lang.String type)
public static UserNotificationEvent getUserNotificationEvent(long userNotificationEventId) throws PortalException
userNotificationEventId - the primary key of the user notification eventPortalException - if a user notification event with the primary key could not be foundpublic static UserNotificationEvent getUserNotificationEventByUuidAndCompanyId(java.lang.String uuid, long companyId) throws PortalException
uuid - the user notification event's UUIDcompanyId - the primary key of the companyPortalException - if a matching user notification event could not be foundpublic static java.util.List<UserNotificationEvent> getUserNotificationEvents(int start, int end)
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.UserNotificationEventModelImpl.
start - the lower bound of the range of user notification eventsend - the upper bound of the range of user notification events (not inclusive)public static java.util.List<UserNotificationEvent> getUserNotificationEvents(long userId)
public static java.util.List<UserNotificationEvent> getUserNotificationEvents(long userId, int deliveryType)
public static java.util.List<UserNotificationEvent> getUserNotificationEvents(long userId, int start, int end)
public static java.util.List<UserNotificationEvent> getUserNotificationEvents(long userId, int deliveryType, int start, int end)
public static int getUserNotificationEventsCount()
public static int getUserNotificationEventsCount(long userId)
public static int getUserNotificationEventsCount(long userId,
int deliveryType)
public static int getUserNotificationEventsCount(long userId,
java.lang.String type,
int deliveryType,
boolean archived)
public static UserNotificationEvent sendUserNotificationEvents(long userId, java.lang.String portletId, int deliveryType, boolean actionRequired, JSONObject notificationEventJSONObject) throws PortalException
PortalExceptionpublic static UserNotificationEvent sendUserNotificationEvents(long userId, java.lang.String portletId, int deliveryType, JSONObject notificationEventJSONObject) throws PortalException
PortalExceptionpublic static UserNotificationEvent updateUserNotificationEvent(java.lang.String uuid, long companyId, boolean archive)
public static UserNotificationEvent updateUserNotificationEvent(UserNotificationEvent userNotificationEvent)
userNotificationEvent - the user notification eventpublic static java.util.List<UserNotificationEvent> updateUserNotificationEvents(java.util.Collection<java.lang.String> uuids, long companyId, boolean archive)
public static UserNotificationEventLocalService getService()