|
Liferay 6.2.0 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@ProviderType
@Transactional(isolation=PORTAL,
rollbackFor={PortalException.class,SystemException.class})
public interface UserNotificationEventLocalServiceProvides 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.
UserNotificationEventLocalServiceUtil,
UserNotificationEventLocalServiceBaseImpl,
UserNotificationEventLocalServiceImpl| Method Summary | |
|---|---|
abstract UserNotificationEvent |
addUserNotificationEvent(long userId,
NotificationEvent notificationEvent)
|
abstract UserNotificationEvent |
addUserNotificationEvent(long userId,
String type,
long timestamp,
long deliverBy,
String payload,
boolean archived,
ServiceContext serviceContext)
|
abstract UserNotificationEvent |
addUserNotificationEvent(UserNotificationEvent userNotificationEvent)
Adds the user notification event to the database. |
abstract List<UserNotificationEvent> |
addUserNotificationEvents(long userId,
Collection<NotificationEvent> notificationEvents)
|
abstract UserNotificationEvent |
createUserNotificationEvent(long userNotificationEventId)
Creates a new user notification event with the primary key. |
abstract UserNotificationEvent |
deleteUserNotificationEvent(long userNotificationEventId)
Deletes the user notification event with the primary key from the database. |
abstract void |
deleteUserNotificationEvent(String uuid,
long companyId)
|
abstract UserNotificationEvent |
deleteUserNotificationEvent(UserNotificationEvent userNotificationEvent)
Deletes the user notification event from the database. |
abstract void |
deleteUserNotificationEvents(Collection<String> uuids,
long companyId)
|
abstract DynamicQuery |
dynamicQuery()
|
abstract List |
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
abstract List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
abstract 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. |
abstract long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows that match the dynamic query. |
abstract long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows that match the dynamic query. |
abstract UserNotificationEvent |
fetchUserNotificationEvent(long userNotificationEventId)
|
abstract UserNotificationEvent |
fetchUserNotificationEventByUuidAndCompanyId(String uuid,
long companyId)
Returns the user notification event with the matching UUID and company. |
abstract List<UserNotificationEvent> |
getArchivedUserNotificationEvents(long userId,
boolean archived)
|
abstract List<UserNotificationEvent> |
getArchivedUserNotificationEvents(long userId,
boolean archived,
int start,
int end)
|
abstract int |
getArchivedUserNotificationEventsCount(long userId,
boolean archived)
|
abstract String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
abstract List<UserNotificationEvent> |
getDeliveredUserNotificationEvents(long userId,
boolean delivered)
|
abstract List<UserNotificationEvent> |
getDeliveredUserNotificationEvents(long userId,
boolean delivered,
int start,
int end)
|
abstract int |
getDeliveredUserNotificationEventsCount(long userId,
boolean delivered)
|
abstract PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
abstract UserNotificationEvent |
getUserNotificationEvent(long userNotificationEventId)
Returns the user notification event with the primary key. |
abstract UserNotificationEvent |
getUserNotificationEventByUuidAndCompanyId(String uuid,
long companyId)
Returns the user notification event with the matching UUID and company. |
abstract List<UserNotificationEvent> |
getUserNotificationEvents(int start,
int end)
Returns a range of all the user notification events. |
abstract List<UserNotificationEvent> |
getUserNotificationEvents(long userId)
|
abstract List<UserNotificationEvent> |
getUserNotificationEvents(long userId,
boolean archived)
Deprecated. As of 6.2.0 getArchivedUserNotificationEvents(long,
boolean) |
abstract List<UserNotificationEvent> |
getUserNotificationEvents(long userId,
boolean archived,
int start,
int end)
Deprecated. As of 6.2.0 getArchivedUserNotificationEvents(long,
boolean, int, int) |
abstract List<UserNotificationEvent> |
getUserNotificationEvents(long userId,
int start,
int end)
|
abstract int |
getUserNotificationEventsCount()
Returns the number of user notification events. |
abstract int |
getUserNotificationEventsCount(long userId)
|
abstract int |
getUserNotificationEventsCount(long userId,
boolean archived)
Deprecated. As of 6.2.0 getArchivedUserNotificationEventsCount(long, boolean) |
abstract void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
abstract UserNotificationEvent |
updateUserNotificationEvent(String uuid,
long companyId,
boolean archive)
|
abstract UserNotificationEvent |
updateUserNotificationEvent(UserNotificationEvent userNotificationEvent)
Updates the user notification event in the database or adds it if it does not yet exist. |
abstract List<UserNotificationEvent> |
updateUserNotificationEvents(Collection<String> uuids,
long companyId,
boolean archive)
|
| Method Detail |
|---|
@Indexable(type=REINDEX)
UserNotificationEvent addUserNotificationEvent(UserNotificationEvent userNotificationEvent)
throws SystemException
userNotificationEvent - the user notification event
SystemException - if a system exception occurredUserNotificationEvent createUserNotificationEvent(long userNotificationEventId)
userNotificationEventId - the primary key for the new user notification event
@Indexable(type=DELETE)
UserNotificationEvent deleteUserNotificationEvent(long userNotificationEventId)
throws PortalException,
SystemException
userNotificationEventId - the primary key of the user notification event
PortalException - if a user notification event with the primary key could not be found
SystemException - if a system exception occurred
@Indexable(type=DELETE)
UserNotificationEvent deleteUserNotificationEvent(UserNotificationEvent userNotificationEvent)
throws SystemException
userNotificationEvent - the user notification event
SystemException - if a system exception occurredDynamicQuery dynamicQuery()
List dynamicQuery(DynamicQuery dynamicQuery)
throws SystemException
dynamicQuery - the dynamic query
SystemException - if a system exception occurred
List dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
throws SystemException
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)
SystemException - if a system exception occurred
List dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator orderByComparator)
throws SystemException
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)
SystemException - if a system exception occurred
long dynamicQueryCount(DynamicQuery dynamicQuery)
throws SystemException
dynamicQuery - the dynamic query
SystemException - if a system exception occurred
long dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
throws SystemException
dynamicQuery - the dynamic queryprojection - the projection to apply to the query
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
UserNotificationEvent fetchUserNotificationEvent(long userNotificationEventId)
throws SystemException
SystemException
@Transactional(propagation=SUPPORTS,
readOnly=true)
UserNotificationEvent fetchUserNotificationEventByUuidAndCompanyId(String uuid,
long companyId)
throws SystemException
uuid - the user notification event's UUIDcompanyId - the primary key of the company
null if a matching user notification event could not be found
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
UserNotificationEvent getUserNotificationEvent(long userNotificationEventId)
throws PortalException,
SystemException
userNotificationEventId - the primary key of the user notification event
PortalException - if a user notification event with the primary key could not be found
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException,
SystemException
getPersistedModel in interface PersistedModelLocalServicePortalException
SystemException
@Transactional(propagation=SUPPORTS,
readOnly=true)
UserNotificationEvent getUserNotificationEventByUuidAndCompanyId(String uuid,
long companyId)
throws PortalException,
SystemException
uuid - the user notification event's UUIDcompanyId - the primary key of the company
PortalException - if a matching user notification event could not be found
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<UserNotificationEvent> getUserNotificationEvents(int start,
int end)
throws SystemException
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)
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getUserNotificationEventsCount()
throws SystemException
SystemException - if a system exception occurred
@Indexable(type=REINDEX)
UserNotificationEvent updateUserNotificationEvent(UserNotificationEvent userNotificationEvent)
throws SystemException
userNotificationEvent - the user notification event
SystemException - if a system exception occurredString getBeanIdentifier()
void setBeanIdentifier(String beanIdentifier)
beanIdentifier - the Spring bean ID for this bean
UserNotificationEvent addUserNotificationEvent(long userId,
NotificationEvent notificationEvent)
throws PortalException,
SystemException
PortalException
SystemException
UserNotificationEvent addUserNotificationEvent(long userId,
String type,
long timestamp,
long deliverBy,
String payload,
boolean archived,
ServiceContext serviceContext)
throws PortalException,
SystemException
PortalException
SystemException
List<UserNotificationEvent> addUserNotificationEvents(long userId,
Collection<NotificationEvent> notificationEvents)
throws PortalException,
SystemException
PortalException
SystemException
void deleteUserNotificationEvent(String uuid,
long companyId)
throws SystemException
SystemException
void deleteUserNotificationEvents(Collection<String> uuids,
long companyId)
throws SystemException
SystemException
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId,
boolean archived)
throws SystemException
SystemException
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId,
boolean archived,
int start,
int end)
throws SystemException
SystemException
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getArchivedUserNotificationEventsCount(long userId,
boolean archived)
throws SystemException
SystemException
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId,
boolean delivered)
throws SystemException
SystemException
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId,
boolean delivered,
int start,
int end)
throws SystemException
SystemException
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getDeliveredUserNotificationEventsCount(long userId,
boolean delivered)
throws SystemException
SystemException
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<UserNotificationEvent> getUserNotificationEvents(long userId)
throws SystemException
SystemException
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<UserNotificationEvent> getUserNotificationEvents(long userId,
boolean archived)
throws SystemException
getArchivedUserNotificationEvents(long,
boolean)
SystemException
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<UserNotificationEvent> getUserNotificationEvents(long userId,
boolean archived,
int start,
int end)
throws SystemException
getArchivedUserNotificationEvents(long,
boolean, int, int)
SystemException
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<UserNotificationEvent> getUserNotificationEvents(long userId,
int start,
int end)
throws SystemException
SystemException
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getUserNotificationEventsCount(long userId)
throws SystemException
SystemException
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getUserNotificationEventsCount(long userId,
boolean archived)
throws SystemException
getArchivedUserNotificationEventsCount(long, boolean)
SystemException
UserNotificationEvent updateUserNotificationEvent(String uuid,
long companyId,
boolean archive)
throws SystemException
SystemException
List<UserNotificationEvent> updateUserNotificationEvents(Collection<String> uuids,
long companyId,
boolean archive)
throws SystemException
SystemException
|
Liferay 6.2.0 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||