com.liferay.portal.kernel.service

Interface UserNotificationEventLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

UserNotificationEventLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface UserNotificationEventLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for UserNotificationEvent. 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:

UserNotificationEventLocalServiceUtil, UserNotificationEventLocalServiceBaseImpl, UserNotificationEventLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
UserNotificationEvent	addUserNotificationEvent(long userId, boolean actionRequired, NotificationEvent notificationEvent)
UserNotificationEvent	addUserNotificationEvent(long userId, NotificationEvent notificationEvent)
UserNotificationEvent	addUserNotificationEvent(long userId, String type, long timestamp, int deliveryType, long deliverBy, String payload, boolean actionRequired, boolean archived, ServiceContext serviceContext)
UserNotificationEvent	addUserNotificationEvent(long userId, String type, long timestamp, int deliveryType, long deliverBy, String payload, boolean archived, ServiceContext serviceContext)
UserNotificationEvent	addUserNotificationEvent(long userId, String type, long timestamp, long deliverBy, String payload, boolean archived, ServiceContext serviceContext) Deprecated. As of Wilberforce (7.0.x), addUserNotificationEvent(long, String, long, int, long, String, boolean, ServiceContext)
UserNotificationEvent	addUserNotificationEvent(UserNotificationEvent userNotificationEvent) Adds the user notification event to the database.
List<UserNotificationEvent>	addUserNotificationEvents(long userId, Collection<NotificationEvent> notificationEvents)
void	archiveUserNotificationEvents(long userId, int deliveryType, boolean actionRequired)
UserNotificationEvent	createUserNotificationEvent(long userNotificationEventId) Creates a new user notification event with the primary key.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
UserNotificationEvent	deleteUserNotificationEvent(long userNotificationEventId) Deletes the user notification event with the primary key from the database.
void	deleteUserNotificationEvent(String uuid, long companyId)
UserNotificationEvent	deleteUserNotificationEvent(UserNotificationEvent userNotificationEvent) Deletes the user notification event from the database.
void	deleteUserNotificationEvents(Collection<String> uuids, long companyId)
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.
UserNotificationEvent	fetchUserNotificationEvent(long userNotificationEventId)
UserNotificationEvent	fetchUserNotificationEventByUuidAndCompanyId(String uuid, long companyId) Returns the user notification event with the matching UUID and company.
ActionableDynamicQuery	getActionableDynamicQuery()
List<UserNotificationEvent>	getArchivedUserNotificationEvents(long userId, boolean archived)
List<UserNotificationEvent>	getArchivedUserNotificationEvents(long userId, boolean actionRequired, boolean archived)
List<UserNotificationEvent>	getArchivedUserNotificationEvents(long userId, boolean actionRequired, boolean archived, int start, int end)
List<UserNotificationEvent>	getArchivedUserNotificationEvents(long userId, boolean archived, int start, int end)
List<UserNotificationEvent>	getArchivedUserNotificationEvents(long userId, int deliveryType, boolean archived)
List<UserNotificationEvent>	getArchivedUserNotificationEvents(long userId, int deliveryType, boolean actionRequired, boolean archived)
List<UserNotificationEvent>	getArchivedUserNotificationEvents(long userId, int deliveryType, boolean actionRequired, boolean archived, int start, int end)
List<UserNotificationEvent>	getArchivedUserNotificationEvents(long userId, int deliveryType, boolean actionRequired, boolean archived, int start, int end, OrderByComparator<UserNotificationEvent> obc)
List<UserNotificationEvent>	getArchivedUserNotificationEvents(long userId, int deliveryType, boolean archived, int start, int end)
int	getArchivedUserNotificationEventsCount(long userId, boolean archived)
int	getArchivedUserNotificationEventsCount(long userId, boolean actionRequired, boolean archived)
int	getArchivedUserNotificationEventsCount(long userId, int deliveryType, boolean archived)
int	getArchivedUserNotificationEventsCount(long userId, int deliveryType, boolean actionRequired, boolean archived)
List<UserNotificationEvent>	getDeliveredUserNotificationEvents(long userId, boolean delivered)
List<UserNotificationEvent>	getDeliveredUserNotificationEvents(long userId, boolean delivered, boolean actionRequired)
List<UserNotificationEvent>	getDeliveredUserNotificationEvents(long userId, boolean delivered, boolean actionRequired, int start, int end)
List<UserNotificationEvent>	getDeliveredUserNotificationEvents(long userId, boolean delivered, int start, int end)
List<UserNotificationEvent>	getDeliveredUserNotificationEvents(long userId, int deliveryType, boolean delivered)
List<UserNotificationEvent>	getDeliveredUserNotificationEvents(long userId, int deliveryType, boolean delivered, boolean actionRequired)
List<UserNotificationEvent>	getDeliveredUserNotificationEvents(long userId, int deliveryType, boolean delivered, boolean actionRequired, int start, int end)
List<UserNotificationEvent>	getDeliveredUserNotificationEvents(long userId, int deliveryType, boolean delivered, boolean actionRequired, int start, int end, OrderByComparator<UserNotificationEvent> obc)
List<UserNotificationEvent>	getDeliveredUserNotificationEvents(long userId, int deliveryType, boolean delivered, int start, int end)
int	getDeliveredUserNotificationEventsCount(long userId, boolean delivered)
int	getDeliveredUserNotificationEventsCount(long userId, boolean delivered, boolean actionRequired)
int	getDeliveredUserNotificationEventsCount(long userId, int deliveryType, boolean delivered)
int	getDeliveredUserNotificationEventsCount(long userId, int deliveryType, boolean delivered, boolean actionRequired)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
List<UserNotificationEvent>	getTypeNotificationEvents(String type)
UserNotificationEvent	getUserNotificationEvent(long userNotificationEventId) Returns the user notification event with the primary key.
UserNotificationEvent	getUserNotificationEventByUuidAndCompanyId(String uuid, long companyId) Returns the user notification event with the matching UUID and company.
List<UserNotificationEvent>	getUserNotificationEvents(int start, int end) Returns a range of all the user notification events.
List<UserNotificationEvent>	getUserNotificationEvents(long userId)
List<UserNotificationEvent>	getUserNotificationEvents(long userId, int deliveryType)
List<UserNotificationEvent>	getUserNotificationEvents(long userId, int start, int end)
List<UserNotificationEvent>	getUserNotificationEvents(long userId, int deliveryType, int start, int end)
int	getUserNotificationEventsCount() Returns the number of user notification events.
int	getUserNotificationEventsCount(long userId)
int	getUserNotificationEventsCount(long userId, int deliveryType)
int	getUserNotificationEventsCount(long userId, String type, int deliveryType, boolean archived)
UserNotificationEvent	sendUserNotificationEvents(long userId, String portletId, int deliveryType, boolean actionRequired, JSONObject notificationEventJSONObject)
UserNotificationEvent	sendUserNotificationEvents(long userId, String portletId, int deliveryType, JSONObject notificationEventJSONObject)
UserNotificationEvent	updateUserNotificationEvent(String uuid, long companyId, boolean archive)
UserNotificationEvent	updateUserNotificationEvent(UserNotificationEvent userNotificationEvent) Updates the user notification event in the database or adds it if it does not yet exist.
List<UserNotificationEvent>	updateUserNotificationEvents(Collection<String> uuids, long companyId, boolean archive)

Method Detail

addUserNotificationEvent

UserNotificationEvent addUserNotificationEvent(long userId,
                                               boolean actionRequired,
                                               NotificationEvent notificationEvent)
                                        throws PortalException

Throws:

PortalException

addUserNotificationEvent

UserNotificationEvent addUserNotificationEvent(long userId,
                                               NotificationEvent notificationEvent)
                                        throws PortalException

Throws:

PortalException

addUserNotificationEvent

UserNotificationEvent addUserNotificationEvent(long userId,
                                               String type,
                                               long timestamp,
                                               int deliveryType,
                                               long deliverBy,
                                               String payload,
                                               boolean actionRequired,
                                               boolean archived,
                                               ServiceContext serviceContext)
                                        throws PortalException

Throws:

PortalException

addUserNotificationEvent

UserNotificationEvent addUserNotificationEvent(long userId,
                                               String type,
                                               long timestamp,
                                               int deliveryType,
                                               long deliverBy,
                                               String payload,
                                               boolean archived,
                                               ServiceContext serviceContext)
                                        throws PortalException

Throws:

PortalException

addUserNotificationEvent

@Deprecated
UserNotificationEvent addUserNotificationEvent(long userId,
                                                           String type,
                                                           long timestamp,
                                                           long deliverBy,
                                                           String payload,
                                                           boolean archived,
                                                           ServiceContext serviceContext)
                                                    throws PortalException

Deprecated. As of Wilberforce (7.0.x), addUserNotificationEvent(long, String, long, int, long, String, boolean, ServiceContext)

Throws:

PortalException

addUserNotificationEvent

@Indexable(type=REINDEX)
UserNotificationEvent addUserNotificationEvent(UserNotificationEvent userNotificationEvent)

Adds the user notification event to the database. Also notifies the appropriate model listeners.

Parameters:

userNotificationEvent - the user notification event

Returns:

the user notification event that was added

addUserNotificationEvents

List<UserNotificationEvent> addUserNotificationEvents(long userId,
                                                      Collection<NotificationEvent> notificationEvents)
                                               throws PortalException

Throws:

PortalException

archiveUserNotificationEvents

void archiveUserNotificationEvents(long userId,
                                   int deliveryType,
                                   boolean actionRequired)
                            throws PortalException

Throws:

PortalException

createUserNotificationEvent

@Transactional(enabled=false)
UserNotificationEvent createUserNotificationEvent(long userNotificationEventId)

Creates a new user notification event with the primary key. Does not add the user notification event to the database.

Parameters:

userNotificationEventId - the primary key for the new user notification event

Returns:

the new user notification event

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteUserNotificationEvent

@Indexable(type=DELETE)
UserNotificationEvent deleteUserNotificationEvent(long userNotificationEventId)
                                                                   throws PortalException

Deletes the user notification event with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

userNotificationEventId - the primary key of the user notification event

Returns:

the user notification event that was removed

Throws:

PortalException - if a user notification event with the primary key could not be found

deleteUserNotificationEvent

void deleteUserNotificationEvent(String uuid,
                                 long companyId)

deleteUserNotificationEvent

@Indexable(type=DELETE)
UserNotificationEvent deleteUserNotificationEvent(UserNotificationEvent userNotificationEvent)

Deletes the user notification event from the database. Also notifies the appropriate model listeners.

Parameters:

userNotificationEvent - the user notification event

Returns:

the user notification event that was removed

deleteUserNotificationEvents

void deleteUserNotificationEvents(Collection<String> uuids,
                                  long companyId)

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

fetchUserNotificationEvent

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserNotificationEvent fetchUserNotificationEvent(long userNotificationEventId)

fetchUserNotificationEventByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserNotificationEvent fetchUserNotificationEventByUuidAndCompanyId(String uuid,
                                                                                                                                      long companyId)

Returns the user notification event with the matching UUID and company.

Parameters:

uuid - the user notification event's UUID

companyId - the primary key of the company

Returns:

the matching user notification event, or null if a matching user notification event could not be found

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getArchivedUserNotificationEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId,
                                                                                                                                 boolean archived)

getArchivedUserNotificationEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId,
                                                                                                                                 boolean actionRequired,
                                                                                                                                 boolean archived)

getArchivedUserNotificationEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId,
                                                                                                                                 boolean actionRequired,
                                                                                                                                 boolean archived,
                                                                                                                                 int start,
                                                                                                                                 int end)

getArchivedUserNotificationEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId,
                                                                                                                                 boolean archived,
                                                                                                                                 int start,
                                                                                                                                 int end)

getArchivedUserNotificationEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId,
                                                                                                                                 int deliveryType,
                                                                                                                                 boolean archived)

getArchivedUserNotificationEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId,
                                                                                                                                 int deliveryType,
                                                                                                                                 boolean actionRequired,
                                                                                                                                 boolean archived)

getArchivedUserNotificationEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId,
                                                                                                                                 int deliveryType,
                                                                                                                                 boolean actionRequired,
                                                                                                                                 boolean archived,
                                                                                                                                 int start,
                                                                                                                                 int end)

getArchivedUserNotificationEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId,
                                                                                                                                 int deliveryType,
                                                                                                                                 boolean actionRequired,
                                                                                                                                 boolean archived,
                                                                                                                                 int start,
                                                                                                                                 int end,
                                                                                                                                 OrderByComparator<UserNotificationEvent> obc)

getArchivedUserNotificationEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId,
                                                                                                                                 int deliveryType,
                                                                                                                                 boolean archived,
                                                                                                                                 int start,
                                                                                                                                 int end)

getArchivedUserNotificationEventsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getArchivedUserNotificationEventsCount(long userId,
                                                                                                              boolean archived)

getArchivedUserNotificationEventsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getArchivedUserNotificationEventsCount(long userId,
                                                                                                              boolean actionRequired,
                                                                                                              boolean archived)

getArchivedUserNotificationEventsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getArchivedUserNotificationEventsCount(long userId,
                                                                                                              int deliveryType,
                                                                                                              boolean archived)

getArchivedUserNotificationEventsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getArchivedUserNotificationEventsCount(long userId,
                                                                                                              int deliveryType,
                                                                                                              boolean actionRequired,
                                                                                                              boolean archived)

getDeliveredUserNotificationEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId,
                                                                                                                                  boolean delivered)

getDeliveredUserNotificationEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId,
                                                                                                                                  boolean delivered,
                                                                                                                                  boolean actionRequired)

getDeliveredUserNotificationEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId,
                                                                                                                                  boolean delivered,
                                                                                                                                  boolean actionRequired,
                                                                                                                                  int start,
                                                                                                                                  int end)

getDeliveredUserNotificationEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId,
                                                                                                                                  boolean delivered,
                                                                                                                                  int start,
                                                                                                                                  int end)

getDeliveredUserNotificationEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId,
                                                                                                                                  int deliveryType,
                                                                                                                                  boolean delivered)

getDeliveredUserNotificationEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId,
                                                                                                                                  int deliveryType,
                                                                                                                                  boolean delivered,
                                                                                                                                  boolean actionRequired)

getDeliveredUserNotificationEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId,
                                                                                                                                  int deliveryType,
                                                                                                                                  boolean delivered,
                                                                                                                                  boolean actionRequired,
                                                                                                                                  int start,
                                                                                                                                  int end)

getDeliveredUserNotificationEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId,
                                                                                                                                  int deliveryType,
                                                                                                                                  boolean delivered,
                                                                                                                                  boolean actionRequired,
                                                                                                                                  int start,
                                                                                                                                  int end,
                                                                                                                                  OrderByComparator<UserNotificationEvent> obc)

getDeliveredUserNotificationEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId,
                                                                                                                                  int deliveryType,
                                                                                                                                  boolean delivered,
                                                                                                                                  int start,
                                                                                                                                  int end)

getDeliveredUserNotificationEventsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getDeliveredUserNotificationEventsCount(long userId,
                                                                                                               boolean delivered)

getDeliveredUserNotificationEventsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getDeliveredUserNotificationEventsCount(long userId,
                                                                                                               boolean delivered,
                                                                                                               boolean actionRequired)

getDeliveredUserNotificationEventsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getDeliveredUserNotificationEventsCount(long userId,
                                                                                                               int deliveryType,
                                                                                                               boolean delivered)

getDeliveredUserNotificationEventsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getDeliveredUserNotificationEventsCount(long userId,
                                                                                                               int deliveryType,
                                                                                                               boolean delivered,
                                                                                                               boolean actionRequired)

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

getTypeNotificationEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserNotificationEvent> getTypeNotificationEvents(String type)

getUserNotificationEvent

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserNotificationEvent getUserNotificationEvent(long userNotificationEventId)
                                                                                                           throws PortalException

Returns the user notification event with the primary key.

Parameters:

userNotificationEventId - the primary key of the user notification event

Returns:

the user notification event

Throws:

PortalException - if a user notification event with the primary key could not be found

getUserNotificationEventByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserNotificationEvent getUserNotificationEventByUuidAndCompanyId(String uuid,
                                                                                                                                    long companyId)
                                                                                                                             throws PortalException

Returns the user notification event with the matching UUID and company.

Parameters:

uuid - the user notification event's UUID

companyId - the primary key of the company

Returns:

the matching user notification event

Throws:

PortalException - if a matching user notification event could not be found

getUserNotificationEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserNotificationEvent> getUserNotificationEvents(int start,
                                                                                                                         int end)

Returns a range of all the user notification 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 UserNotificationEventModelImpl. 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 user notification events

end - the upper bound of the range of user notification events (not inclusive)

Returns:

the range of user notification events

getUserNotificationEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserNotificationEvent> getUserNotificationEvents(long userId)

getUserNotificationEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserNotificationEvent> getUserNotificationEvents(long userId,
                                                                                                                         int deliveryType)

getUserNotificationEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserNotificationEvent> getUserNotificationEvents(long userId,
                                                                                                                         int start,
                                                                                                                         int end)

getUserNotificationEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserNotificationEvent> getUserNotificationEvents(long userId,
                                                                                                                         int deliveryType,
                                                                                                                         int start,
                                                                                                                         int end)

getUserNotificationEventsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserNotificationEventsCount()

Returns the number of user notification events.

Returns:

the number of user notification events

getUserNotificationEventsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserNotificationEventsCount(long userId)

getUserNotificationEventsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserNotificationEventsCount(long userId,
                                                                                                      int deliveryType)

getUserNotificationEventsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserNotificationEventsCount(long userId,
                                                                                                      String type,
                                                                                                      int deliveryType,
                                                                                                      boolean archived)

sendUserNotificationEvents

UserNotificationEvent sendUserNotificationEvents(long userId,
                                                 String portletId,
                                                 int deliveryType,
                                                 boolean actionRequired,
                                                 JSONObject notificationEventJSONObject)
                                          throws PortalException

Throws:

PortalException

sendUserNotificationEvents

UserNotificationEvent sendUserNotificationEvents(long userId,
                                                 String portletId,
                                                 int deliveryType,
                                                 JSONObject notificationEventJSONObject)
                                          throws PortalException

Throws:

PortalException

updateUserNotificationEvent

UserNotificationEvent updateUserNotificationEvent(String uuid,
                                                  long companyId,
                                                  boolean archive)

updateUserNotificationEvent

@Indexable(type=REINDEX)
UserNotificationEvent updateUserNotificationEvent(UserNotificationEvent userNotificationEvent)

Updates the user notification event in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

userNotificationEvent - the user notification event

Returns:

the user notification event that was updated

updateUserNotificationEvents

List<UserNotificationEvent> updateUserNotificationEvents(Collection<String> uuids,
                                                         long companyId,
                                                         boolean archive)