Liferay 6.2-ce-ga5

com.liferay.portal.service
Interface UserNotificationEventLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
UserNotificationEventLocalServiceBaseImpl, UserNotificationEventLocalServiceImpl, 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.

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, long companyId)
           
 UserNotificationEvent deleteUserNotificationEvent(UserNotificationEvent userNotificationEvent)
          Deletes the user notification event from the database.
 void deleteUserNotificationEvents(Collection<String> uuids, long companyId)
           
 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.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
 UserNotificationEvent fetchUserNotificationEvent(long userNotificationEventId)
           
 UserNotificationEvent fetchUserNotificationEventByUuidAndCompanyId(String uuid, long companyId)
          Returns the user notification event with the matching UUID and company.
 List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId, boolean archived)
           
 List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId, boolean archived, int start, int end)
           
 int getArchivedUserNotificationEventsCount(long userId, boolean archived)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId, boolean delivered)
           
 List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId, boolean delivered, int start, int end)
           
 int getDeliveredUserNotificationEventsCount(long userId, boolean delivered)
           
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 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, boolean archived)
          Deprecated. As of 6.2.0 getArchivedUserNotificationEvents(long, boolean)
 List<UserNotificationEvent> getUserNotificationEvents(long userId, boolean archived, int start, int end)
          Deprecated. As of 6.2.0 getArchivedUserNotificationEvents(long, boolean, int, int)
 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)
          Deprecated. As of 6.2.0 getArchivedUserNotificationEventsCount(long, boolean)
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 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

@Indexable(type=REINDEX)
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

@Indexable(type=DELETE)
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

@Indexable(type=DELETE)
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. 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
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. 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
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

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the 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

fetchUserNotificationEventByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserNotificationEvent fetchUserNotificationEventByUuidAndCompanyId(String uuid,
                                                                                                            long companyId)
                                                                   throws SystemException
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
Throws:
SystemException - if a system exception occurred

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

getUserNotificationEventByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserNotificationEvent getUserNotificationEventByUuidAndCompanyId(String uuid,
                                                                                                          long companyId)
                                                                 throws PortalException,
                                                                        SystemException
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
SystemException - if a system exception occurred

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

@Indexable(type=REINDEX)
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

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,
                                 long companyId)
                                 throws SystemException
Throws:
SystemException

deleteUserNotificationEvents

void deleteUserNotificationEvents(Collection<String> uuids,
                                  long companyId)
                                  throws SystemException
Throws:
SystemException

getArchivedUserNotificationEvents

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

getArchivedUserNotificationEvents

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

getArchivedUserNotificationEventsCount

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

getDeliveredUserNotificationEvents

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

getDeliveredUserNotificationEvents

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

getDeliveredUserNotificationEventsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getDeliveredUserNotificationEventsCount(long userId,
                                                                                     boolean delivered)
                                            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
Deprecated. As of 6.2.0 getArchivedUserNotificationEvents(long, boolean)

Throws:
SystemException

getUserNotificationEvents

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

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
Deprecated. As of 6.2.0 getArchivedUserNotificationEventsCount(long, boolean)

Throws:
SystemException

updateUserNotificationEvent

UserNotificationEvent updateUserNotificationEvent(String uuid,
                                                  long companyId,
                                                  boolean archive)
                                                  throws SystemException
Throws:
SystemException

updateUserNotificationEvents

List<UserNotificationEvent> updateUserNotificationEvents(Collection<String> uuids,
                                                         long companyId,
                                                         boolean archive)
                                                         throws SystemException
Throws:
SystemException

Liferay 6.2-ce-ga5