Interface UserNotificationDeliveryLocalService
- All Superinterfaces:
BaseLocalService
,PersistedModelLocalService
- All Known Implementing Classes:
UserNotificationDeliveryLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddUserNotificationDelivery
(long userId, String portletId, long classNameId, int notificationType, int deliveryType, boolean deliver) addUserNotificationDelivery
(UserNotificationDelivery userNotificationDelivery) Adds the user notification delivery to the database.createPersistedModel
(Serializable primaryKeyObj) createUserNotificationDelivery
(long userNotificationDeliveryId) Creates a new user notification delivery with the primary key.deletePersistedModel
(PersistedModel persistedModel) void
deleteUserNotificationDeliveries
(long userId) deleteUserNotificationDelivery
(long userNotificationDeliveryId) Deletes the user notification delivery with the primary key from the database.void
deleteUserNotificationDelivery
(long userId, String portletId, long classNameId, int notificationType, int deliveryType) deleteUserNotificationDelivery
(UserNotificationDelivery userNotificationDelivery) Deletes the user notification delivery from the database.<T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) <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.fetchUserNotificationDelivery
(long userNotificationDeliveryId) fetchUserNotificationDelivery
(long userId, String portletId, long classNameId, int notificationType, int deliveryType) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) getUserNotificationDeliveries
(int start, int end) Returns a range of all the user notification deliveries.int
Returns the number of user notification deliveries.getUserNotificationDelivery
(long userNotificationDeliveryId) Returns the user notification delivery with the primary key.getUserNotificationDelivery
(long userId, String portletId, long classNameId, int notificationType, int deliveryType, boolean deliver) updateUserNotificationDelivery
(long userNotificationDeliveryId, boolean deliver) updateUserNotificationDelivery
(UserNotificationDelivery userNotificationDelivery) Updates the user notification delivery in the database or adds it if it does not yet exist.Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addUserNotificationDelivery
UserNotificationDelivery addUserNotificationDelivery(long userId, String portletId, long classNameId, int notificationType, int deliveryType, boolean deliver) throws PortalException - Throws:
PortalException
-
addUserNotificationDelivery
@Indexable(type=REINDEX) UserNotificationDelivery addUserNotificationDelivery(UserNotificationDelivery userNotificationDelivery) Adds the user notification delivery to the database. Also notifies the appropriate model listeners.Important: Inspect UserNotificationDeliveryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
userNotificationDelivery
- the user notification delivery- Returns:
- the user notification delivery that was added
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
createUserNotificationDelivery
@Transactional(enabled=false) UserNotificationDelivery createUserNotificationDelivery(long userNotificationDeliveryId) Creates a new user notification delivery with the primary key. Does not add the user notification delivery to the database.- Parameters:
userNotificationDeliveryId
- the primary key for the new user notification delivery- Returns:
- the new user notification delivery
-
deletePersistedModel
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deleteUserNotificationDeliveries
void deleteUserNotificationDeliveries(long userId) -
deleteUserNotificationDelivery
@Indexable(type=DELETE) UserNotificationDelivery deleteUserNotificationDelivery(long userNotificationDeliveryId) throws PortalException Deletes the user notification delivery with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect UserNotificationDeliveryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
userNotificationDeliveryId
- the primary key of the user notification delivery- Returns:
- the user notification delivery that was removed
- Throws:
PortalException
- if a user notification delivery with the primary key could not be found
-
deleteUserNotificationDelivery
void deleteUserNotificationDelivery(long userId, String portletId, long classNameId, int notificationType, int deliveryType) -
deleteUserNotificationDelivery
@Indexable(type=DELETE) UserNotificationDelivery deleteUserNotificationDelivery(UserNotificationDelivery userNotificationDelivery) Deletes the user notification delivery from the database. Also notifies the appropriate model listeners.Important: Inspect UserNotificationDeliveryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
userNotificationDelivery
- the user notification delivery- Returns:
- the user notification delivery that was removed
-
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacePersistedModelLocalService
-
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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.UserNotificationDeliveryModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.UserNotificationDeliveryModelImpl
.- Parameters:
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 (optionallynull
)- 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 queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchUserNotificationDelivery
@Transactional(propagation=SUPPORTS, readOnly=true) UserNotificationDelivery fetchUserNotificationDelivery(long userNotificationDeliveryId) -
fetchUserNotificationDelivery
@Transactional(propagation=SUPPORTS, readOnly=true) UserNotificationDelivery fetchUserNotificationDelivery(long userId, String portletId, long classNameId, int notificationType, int deliveryType) -
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery() -
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 interfacePersistedModelLocalService
- Throws:
PortalException
-
getUserNotificationDeliveries
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserNotificationDelivery> getUserNotificationDeliveries(int start, int end) Returns a range of all the user notification deliveries.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.UserNotificationDeliveryModelImpl
.- Parameters:
start
- the lower bound of the range of user notification deliveriesend
- the upper bound of the range of user notification deliveries (not inclusive)- Returns:
- the range of user notification deliveries
-
getUserNotificationDeliveriesCount
Returns the number of user notification deliveries.- Returns:
- the number of user notification deliveries
-
getUserNotificationDelivery
@Transactional(propagation=SUPPORTS, readOnly=true) UserNotificationDelivery getUserNotificationDelivery(long userNotificationDeliveryId) throws PortalException Returns the user notification delivery with the primary key.- Parameters:
userNotificationDeliveryId
- the primary key of the user notification delivery- Returns:
- the user notification delivery
- Throws:
PortalException
- if a user notification delivery with the primary key could not be found
-
getUserNotificationDelivery
@Transactional(propagation=SUPPORTS, readOnly=true) UserNotificationDelivery getUserNotificationDelivery(long userId, String portletId, long classNameId, int notificationType, int deliveryType, boolean deliver) throws PortalException - Throws:
PortalException
-
updateUserNotificationDelivery
UserNotificationDelivery updateUserNotificationDelivery(long userNotificationDeliveryId, boolean deliver) -
updateUserNotificationDelivery
@Indexable(type=REINDEX) UserNotificationDelivery updateUserNotificationDelivery(UserNotificationDelivery userNotificationDelivery) Updates the user notification delivery in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect UserNotificationDeliveryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
userNotificationDelivery
- the user notification delivery- Returns:
- the user notification delivery that was updated
-