@ProviderType @Transactional(isolation=PORTAL, rollbackFor={PortalException.class,SystemException.class}) public interface UserNotificationEventLocalService extends BaseLocalService, PersistedModelLocalService
UserNotificationEventLocalServiceUtil
,
UserNotificationEventLocalServiceBaseImpl
,
UserNotificationEventLocalServiceImpl
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.
|
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.
|
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 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,
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) |
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery()
DynamicQuery dynamicQuery()
@Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
deletePersistedModel
in interface PersistedModelLocalService
PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
getPersistedModel
in interface PersistedModelLocalService
PortalException
@Indexable(type=REINDEX) UserNotificationEvent addUserNotificationEvent(UserNotificationEvent userNotificationEvent)
userNotificationEvent
- the user notification eventUserNotificationEvent addUserNotificationEvent(long userId, boolean actionRequired, NotificationEvent notificationEvent) throws PortalException
PortalException
UserNotificationEvent addUserNotificationEvent(long userId, NotificationEvent notificationEvent) throws PortalException
PortalException
UserNotificationEvent addUserNotificationEvent(long userId, String type, long timestamp, int deliveryType, long deliverBy, String payload, boolean actionRequired, boolean archived, ServiceContext serviceContext) throws PortalException
PortalException
UserNotificationEvent addUserNotificationEvent(long userId, String type, long timestamp, int deliveryType, long deliverBy, String payload, boolean archived, ServiceContext serviceContext) throws PortalException
PortalException
@Deprecated UserNotificationEvent addUserNotificationEvent(long userId, String type, long timestamp, long deliverBy, String payload, boolean archived, ServiceContext serviceContext) throws PortalException
addUserNotificationEvent(long, String,
long, int, long, String, boolean, ServiceContext)
PortalException
UserNotificationEvent createUserNotificationEvent(long userNotificationEventId)
userNotificationEventId
- the primary key for the new user notification event@Indexable(type=DELETE) UserNotificationEvent deleteUserNotificationEvent(UserNotificationEvent userNotificationEvent)
userNotificationEvent
- the user notification event@Indexable(type=DELETE) 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 found@Transactional(propagation=SUPPORTS, readOnly=true) UserNotificationEvent fetchUserNotificationEvent(long userNotificationEventId)
@Transactional(propagation=SUPPORTS, readOnly=true) UserNotificationEvent fetchUserNotificationEventByUuidAndCompanyId(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 found@Transactional(propagation=SUPPORTS, readOnly=true) 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 found@Transactional(propagation=SUPPORTS, readOnly=true) UserNotificationEvent getUserNotificationEventByUuidAndCompanyId(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 foundUserNotificationEvent sendUserNotificationEvents(long userId, String portletId, int deliveryType, boolean actionRequired, JSONObject notificationEventJSONObject) throws PortalException
PortalException
UserNotificationEvent sendUserNotificationEvents(long userId, String portletId, int deliveryType, JSONObject notificationEventJSONObject) throws PortalException
PortalException
@Indexable(type=REINDEX) UserNotificationEvent updateUserNotificationEvent(UserNotificationEvent userNotificationEvent)
userNotificationEvent
- the user notification eventUserNotificationEvent updateUserNotificationEvent(String uuid, long companyId, boolean archive)
@Transactional(propagation=SUPPORTS, readOnly=true) int getArchivedUserNotificationEventsCount(long userId, boolean actionRequired, boolean archived)
@Transactional(propagation=SUPPORTS, readOnly=true) int getArchivedUserNotificationEventsCount(long userId, boolean archived)
@Transactional(propagation=SUPPORTS, readOnly=true) int getArchivedUserNotificationEventsCount(long userId, int deliveryType, boolean actionRequired, boolean archived)
@Transactional(propagation=SUPPORTS, readOnly=true) int getArchivedUserNotificationEventsCount(long userId, int deliveryType, boolean archived)
@Transactional(propagation=SUPPORTS, readOnly=true) int getDeliveredUserNotificationEventsCount(long userId, boolean delivered)
@Transactional(propagation=SUPPORTS, readOnly=true) int getDeliveredUserNotificationEventsCount(long userId, boolean delivered, boolean actionRequired)
@Transactional(propagation=SUPPORTS, readOnly=true) int getDeliveredUserNotificationEventsCount(long userId, int deliveryType, boolean delivered)
@Transactional(propagation=SUPPORTS, readOnly=true) int getDeliveredUserNotificationEventsCount(long userId, int deliveryType, boolean delivered, boolean actionRequired)
@Transactional(propagation=SUPPORTS, readOnly=true) int getUserNotificationEventsCount()
@Transactional(propagation=SUPPORTS, readOnly=true) int getUserNotificationEventsCount(long userId)
@Transactional(propagation=SUPPORTS, readOnly=true) int getUserNotificationEventsCount(long userId, int deliveryType)
@Transactional(propagation=SUPPORTS, readOnly=true) int getUserNotificationEventsCount(long userId, String type, int deliveryType, boolean archived)
String getOSGiServiceIdentifier()
List<UserNotificationEvent> addUserNotificationEvents(long userId, Collection<NotificationEvent> notificationEvents) throws PortalException
PortalException
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic query<T> 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 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.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)<T> 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 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.
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
)@Transactional(propagation=SUPPORTS, readOnly=true) List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId, boolean actionRequired, boolean archived)
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId, boolean actionRequired, boolean archived, int start, int end)
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId, boolean archived)
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId, boolean archived, int start, int end)
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId, int deliveryType, boolean actionRequired, boolean archived)
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId, int deliveryType, boolean actionRequired, boolean archived, int start, int end)
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId, int deliveryType, boolean archived)
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId, int deliveryType, boolean archived, int start, int end)
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId, boolean delivered)
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId, boolean delivered, boolean actionRequired)
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId, boolean delivered, boolean actionRequired, int start, int end)
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId, boolean delivered, int start, int end)
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId, int deliveryType, boolean delivered)
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId, int deliveryType, boolean delivered, boolean actionRequired)
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId, int deliveryType, boolean delivered, boolean actionRequired, int start, int end)
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId, int deliveryType, boolean delivered, int start, int end)
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserNotificationEvent> getTypeNotificationEvents(String type)
@Transactional(propagation=SUPPORTS, readOnly=true) 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 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.
start
- the lower bound of the range of user notification eventsend
- the upper bound of the range of user notification events (not inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) List<UserNotificationEvent> getUserNotificationEvents(long userId)
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserNotificationEvent> getUserNotificationEvents(long userId, int deliveryType)
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserNotificationEvent> getUserNotificationEvents(long userId, int deliveryType, int start, int end)
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserNotificationEvent> getUserNotificationEvents(long userId, int start, int end)
List<UserNotificationEvent> updateUserNotificationEvents(Collection<String> uuids, long companyId, boolean archive)
long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querylong dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the queryvoid deleteUserNotificationEvent(String uuid, long companyId)
void deleteUserNotificationEvents(Collection<String> uuids, long companyId)