com.liferay.portal.service
Interface UserNotificationEventLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

UserNotificationEventLocalServiceBaseImpl, UserNotificationEventLocalServiceImpl, UserNotificationEventLocalServiceWrapper

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

The interface for the user notification event local service.

This is a local service. 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.

See Also:

UserNotificationEventLocalServiceUtil, UserNotificationEventLocalServiceBaseImpl, UserNotificationEventLocalServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary

UserNotificationEvent	addUserNotificationEvent(long userId, NotificationEvent notificationEvent)
UserNotificationEvent	addUserNotificationEvent(long userId, String type, long timestamp, long deliverBy, String payload, boolean archived, ServiceContext serviceContext)
UserNotificationEvent	addUserNotificationEvent(UserNotificationEvent userNotificationEvent) Adds the user notification event to the database.
List<UserNotificationEvent>	addUserNotificationEvents(long userId, Collection<NotificationEvent> notificationEvents)
UserNotificationEvent	createUserNotificationEvent(long userNotificationEventId) Creates a new user notification event with the primary key.
UserNotificationEvent	deleteUserNotificationEvent(long userNotificationEventId) Deletes the user notification event with the primary key from the database.
void	deleteUserNotificationEvent(String uuid)
UserNotificationEvent	deleteUserNotificationEvent(UserNotificationEvent userNotificationEvent) Deletes the user notification event from the database.
void	deleteUserNotificationEvents(Collection<String> uuids)
DynamicQuery	dynamicQuery()
List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator 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 that match the dynamic query.
UserNotificationEvent	fetchUserNotificationEvent(long userNotificationEventId)
String	getBeanIdentifier() Returns the Spring bean ID for this bean.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
UserNotificationEvent	getUserNotificationEvent(long userNotificationEventId) Returns the user notification event with the primary key.
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, boolean archived)
List<UserNotificationEvent>	getUserNotificationEvents(long userId, boolean archived, int start, int end)
List<UserNotificationEvent>	getUserNotificationEvents(long userId, int start, int end)
int	getUserNotificationEventsCount() Returns the number of user notification events.
int	getUserNotificationEventsCount(long userId)
int	getUserNotificationEventsCount(long userId, boolean archived)
void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
UserNotificationEvent	updateUserNotificationEvent(String uuid, boolean archive)
UserNotificationEvent	updateUserNotificationEvent(UserNotificationEvent userNotificationEvent) Updates the user notification event in the database or adds it if it does not yet exist.
UserNotificationEvent	updateUserNotificationEvent(UserNotificationEvent userNotificationEvent, boolean merge) Updates the user notification event in the database or adds it if it does not yet exist.
List<UserNotificationEvent>	updateUserNotificationEvents(Collection<String> uuids, boolean archive)

Method Detail

addUserNotificationEvent

UserNotificationEvent addUserNotificationEvent(UserNotificationEvent userNotificationEvent)
                                               throws SystemException

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

Throws:

SystemException - if a system exception occurred

createUserNotificationEvent

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

deleteUserNotificationEvent

UserNotificationEvent deleteUserNotificationEvent(long userNotificationEventId)
                                                  throws PortalException,
                                                         SystemException

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

SystemException - if a system exception occurred

deleteUserNotificationEvent

UserNotificationEvent deleteUserNotificationEvent(UserNotificationEvent userNotificationEvent)
                                                  throws SystemException

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException

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.

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException

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.

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

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchUserNotificationEvent

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

Throws:

SystemException

getUserNotificationEvent

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

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

SystemException - if a system exception occurred

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

SystemException

getUserNotificationEvents

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

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.

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

Throws:

SystemException - if a system exception occurred

getUserNotificationEventsCount

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

Returns the number of user notification events.

Returns:

the number of user notification events

Throws:

SystemException - if a system exception occurred

updateUserNotificationEvent

UserNotificationEvent updateUserNotificationEvent(UserNotificationEvent userNotificationEvent)
                                                  throws SystemException

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

Throws:

SystemException - if a system exception occurred

updateUserNotificationEvent

UserNotificationEvent updateUserNotificationEvent(UserNotificationEvent userNotificationEvent,
                                                  boolean merge)
                                                  throws SystemException

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

merge - whether to merge the user notification event with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the user notification event that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addUserNotificationEvent

UserNotificationEvent addUserNotificationEvent(long userId,
                                               NotificationEvent notificationEvent)
                                               throws PortalException,
                                                      SystemException

Throws:

PortalException

SystemException

addUserNotificationEvent

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

Throws:

PortalException

SystemException

addUserNotificationEvents

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

Throws:

PortalException

SystemException

deleteUserNotificationEvent

void deleteUserNotificationEvent(String uuid)
                                 throws SystemException

Throws:

SystemException

deleteUserNotificationEvents

void deleteUserNotificationEvents(Collection<String> uuids)
                                  throws SystemException

Throws:

SystemException

getUserNotificationEvents

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

Throws:

SystemException

getUserNotificationEvents

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

Throws:

SystemException

getUserNotificationEvents

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

Throws:

SystemException

getUserNotificationEvents

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

Throws:

SystemException

getUserNotificationEventsCount

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

Throws:

SystemException

getUserNotificationEventsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserNotificationEventsCount(long userId,
                                                                            boolean archived)
                                   throws SystemException

Throws:

SystemException

updateUserNotificationEvent

UserNotificationEvent updateUserNotificationEvent(String uuid,
                                                  boolean archive)
                                                  throws SystemException

Throws:

SystemException

updateUserNotificationEvents

List<UserNotificationEvent> updateUserNotificationEvents(Collection<String> uuids,
                                                         boolean archive)
                                                         throws SystemException

Throws:

SystemException