Class UserNotificationDeliveryLocalServiceUtil
com.liferay.portal.service.impl.UserNotificationDeliveryLocalServiceImpl
and
is an access point for service operations in application layer code running
on the local server. 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.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic UserNotificationDelivery
addUserNotificationDelivery
(long userId, String portletId, long classNameId, int notificationType, int deliveryType, boolean deliver) static UserNotificationDelivery
addUserNotificationDelivery
(UserNotificationDelivery userNotificationDelivery) Adds the user notification delivery to the database.static PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static UserNotificationDelivery
createUserNotificationDelivery
(long userNotificationDeliveryId) Creates a new user notification delivery with the primary key.static PersistedModel
deletePersistedModel
(PersistedModel persistedModel) static void
deleteUserNotificationDeliveries
(long userId) static UserNotificationDelivery
deleteUserNotificationDelivery
(long userNotificationDeliveryId) Deletes the user notification delivery with the primary key from the database.static void
deleteUserNotificationDelivery
(long userId, String portletId, long classNameId, int notificationType, int deliveryType) static UserNotificationDelivery
deleteUserNotificationDelivery
(UserNotificationDelivery userNotificationDelivery) Deletes the user notification delivery from the database.static <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static DynamicQuery
static <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <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.static <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.static long
dynamicQueryCount
(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static long
dynamicQueryCount
(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.static UserNotificationDelivery
fetchUserNotificationDelivery
(long userNotificationDeliveryId) static UserNotificationDelivery
fetchUserNotificationDelivery
(long userId, String portletId, long classNameId, int notificationType, int deliveryType) static ActionableDynamicQuery
static String
Returns the OSGi service identifier.static PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static List<UserNotificationDelivery>
getUserNotificationDeliveries
(int start, int end) Returns a range of all the user notification deliveries.static int
Returns the number of user notification deliveries.static UserNotificationDelivery
getUserNotificationDelivery
(long userNotificationDeliveryId) Returns the user notification delivery with the primary key.static UserNotificationDelivery
getUserNotificationDelivery
(long userId, String portletId, long classNameId, int notificationType, int deliveryType, boolean deliver) static void
static UserNotificationDelivery
updateUserNotificationDelivery
(long userNotificationDeliveryId, boolean deliver) static UserNotificationDelivery
updateUserNotificationDelivery
(UserNotificationDelivery userNotificationDelivery) Updates the user notification delivery in the database or adds it if it does not yet exist.
-
Constructor Details
-
UserNotificationDeliveryLocalServiceUtil
public UserNotificationDeliveryLocalServiceUtil()
-
-
Method Details
-
addUserNotificationDelivery
public static UserNotificationDelivery addUserNotificationDelivery(long userId, String portletId, long classNameId, int notificationType, int deliveryType, boolean deliver) throws PortalException - Throws:
PortalException
-
addUserNotificationDelivery
public static 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
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - Throws:
PortalException
-
createUserNotificationDelivery
public static 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
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException - Throws:
PortalException
-
deleteUserNotificationDeliveries
public static void deleteUserNotificationDeliveries(long userId) -
deleteUserNotificationDelivery
public static 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
public static void deleteUserNotificationDelivery(long userId, String portletId, long classNameId, int notificationType, int deliveryType) -
deleteUserNotificationDelivery
public static 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
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dslQueryCount
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dynamicQuery
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
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
public static <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
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
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
public static UserNotificationDelivery fetchUserNotificationDelivery(long userNotificationDeliveryId) -
fetchUserNotificationDelivery
public static UserNotificationDelivery fetchUserNotificationDelivery(long userId, String portletId, long classNameId, int notificationType, int deliveryType) -
getActionableDynamicQuery
-
getIndexableActionableDynamicQuery
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
getUserNotificationDeliveries
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
public static int getUserNotificationDeliveriesCount()Returns the number of user notification deliveries.- Returns:
- the number of user notification deliveries
-
getUserNotificationDelivery
public static 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
public static UserNotificationDelivery getUserNotificationDelivery(long userId, String portletId, long classNameId, int notificationType, int deliveryType, boolean deliver) throws PortalException - Throws:
PortalException
-
updateUserNotificationDelivery
public static UserNotificationDelivery updateUserNotificationDelivery(long userNotificationDeliveryId, boolean deliver) -
updateUserNotificationDelivery
public static 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
-
getService
-
setService
-