Class SubscriptionLocalServiceUtil
com.liferay.subscription.service.impl.SubscriptionLocalServiceImpl 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.- See Also:
- Generated:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic SubscriptionaddSubscription(long userId, long groupId, String className, long classPK) Subscribes the user to the entity, notifying him the instant the entity is created, deleted, or modified.static SubscriptionaddSubscription(long userId, long groupId, String className, long classPK, String frequency) Subscribes the user to the entity, notifying him at the given frequency.static SubscriptionaddSubscription(Subscription subscription) Adds the subscription to the database.static com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static SubscriptioncreateSubscription(long subscriptionId) Creates a new subscription with the primary key.static voiddeleteGroupSubscriptions(long groupId) static com.liferay.portal.kernel.model.PersistedModeldeletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) static SubscriptiondeleteSubscription(long subscriptionId) Deletes the subscription with the primary key from the database.static voiddeleteSubscription(long userId, String className, long classPK) Deletes the user's subscription to the entity.static SubscriptiondeleteSubscription(Subscription subscription) Deletes the subscription from the database.static voiddeleteSubscriptions(long userId) Deletes all the subscriptions of the user.static voiddeleteSubscriptions(long userId, long groupId) static voiddeleteSubscriptions(long companyId, String className, long classPK) Deletes all the subscriptions to the entity.static <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static com.liferay.portal.kernel.dao.orm.DynamicQuerystatic <T> List<T>dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <T> List<T>dynamicQuery(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.static longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.static SubscriptionfetchSubscription(long subscriptionId) static SubscriptionfetchSubscription(long companyId, long userId, String className, long classPK) static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerystatic com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuerystatic StringReturns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) static SubscriptionLocalServicestatic SubscriptiongetSubscription(long subscriptionId) Returns the subscription with the primary key.static SubscriptiongetSubscription(long companyId, long userId, String className, long classPK) Returns the subscription of the user to the entity.static List<Subscription>getSubscriptions(int start, int end) Returns a range of all the subscriptions.static List<Subscription>getSubscriptions(long companyId, long userId, String className, long[] classPKs) Returns all the subscriptions of the user to the entities.static List<Subscription>getSubscriptions(long companyId, String className, long classPK) Returns all the subscriptions to the entity.static List<Subscription>getSubscriptions(String className) Deprecated.As of Athanasius (7.3.x), with no direct replacementstatic intReturns the number of subscriptions.static intgetSubscriptionsCount(String className) Deprecated.As of Athanasius (7.3.x), with no direct replacementstatic List<Subscription>getUserSubscriptions(long userId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<Subscription> orderByComparator) Returns an ordered range of all the subscriptions of the user.static List<Subscription>getUserSubscriptions(long userId, String className) Returns all the subscriptions of the user to the entities with the class name.static intgetUserSubscriptionsCount(long userId) Returns the number of subscriptions of the user.static booleanisSubscribed(long companyId, long userId, String className, long classPK) Returnstrueif the user is subscribed to the entity.static booleanisSubscribed(long companyId, long userId, String className, long[] classPKs) Returnstrueif the user is subscribed to any of the entities.static SubscriptionupdateSubscription(Subscription subscription) Updates the subscription in the database or adds it if it does not yet exist.static voidupdateSubscriptions(long companyId, long classNameId, long oldClassPK, long newClassPK)
-
Constructor Details
-
SubscriptionLocalServiceUtil
public SubscriptionLocalServiceUtil()
-
-
Method Details
-
addSubscription
public static Subscription addSubscription(long userId, long groupId, String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException Subscribes the user to the entity, notifying him the instant the entity is created, deleted, or modified.If there is no asset entry with the class name and class PK a new asset entry is created.
A social activity for the subscription is created using the asset entry associated with the class name and class PK, or the newly created asset entry.
- Parameters:
userId- the primary key of the usergroupId- the primary key of the entity's groupclassName- the entity's class nameclassPK- the primary key of the entity's instance- Returns:
- the subscription
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
addSubscription
public static Subscription addSubscription(long userId, long groupId, String className, long classPK, String frequency) throws com.liferay.portal.kernel.exception.PortalException Subscribes the user to the entity, notifying him at the given frequency.If there is no asset entry with the class name and class PK a new asset entry is created.
A social activity for the subscription is created using the asset entry associated with the class name and class PK, or the newly created asset entry.
- Parameters:
userId- the primary key of the usergroupId- the primary key of the entity's groupclassName- the entity's class nameclassPK- the primary key of the entity's instancefrequency- the frequency for notifications- Returns:
- the subscription
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
addSubscription
Adds the subscription to the database. Also notifies the appropriate model listeners.Important: Inspect SubscriptionLocalServiceImpl 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:
subscription- the subscription- Returns:
- the subscription that was added
-
createPersistedModel
public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
createSubscription
Creates a new subscription with the primary key. Does not add the subscription to the database.- Parameters:
subscriptionId- the primary key for the new subscription- Returns:
- the new subscription
-
deleteGroupSubscriptions
public static void deleteGroupSubscriptions(long groupId) -
deletePersistedModel
public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteSubscription
public static Subscription deleteSubscription(long subscriptionId) throws com.liferay.portal.kernel.exception.PortalException Deletes the subscription with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect SubscriptionLocalServiceImpl 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:
subscriptionId- the primary key of the subscription- Returns:
- the subscription that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a subscription with the primary key could not be found
-
deleteSubscription
public static void deleteSubscription(long userId, String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException Deletes the user's subscription to the entity. A social activity with the unsubscribe action is created.- Parameters:
userId- the primary key of the userclassName- the entity's class nameclassPK- the primary key of the entity's instance- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteSubscription
public static Subscription deleteSubscription(Subscription subscription) throws com.liferay.portal.kernel.exception.PortalException Deletes the subscription from the database. Also notifies the appropriate model listeners.Important: Inspect SubscriptionLocalServiceImpl 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:
subscription- the subscription- Returns:
- the subscription that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteSubscriptions
public static void deleteSubscriptions(long userId) throws com.liferay.portal.kernel.exception.PortalException Deletes all the subscriptions of the user.- Parameters:
userId- the primary key of the user- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteSubscriptions
public static void deleteSubscriptions(long userId, long groupId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteSubscriptions
public static void deleteSubscriptions(long companyId, String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException Deletes all the subscriptions to the entity.- Parameters:
companyId- the primary key of the companyclassName- the entity's class nameclassPK- the primary key of the entity's instance- Throws:
com.liferay.portal.kernel.exception.PortalException
-
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
public static com.liferay.portal.kernel.dao.orm.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
public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.subscription.model.impl.SubscriptionModelImpl.- 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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.subscription.model.impl.SubscriptionModelImpl.- 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
public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.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
public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.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
-
fetchSubscription
-
fetchSubscription
public static Subscription fetchSubscription(long companyId, long userId, String className, long classPK) -
getActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getIndexableActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getSubscription
public static Subscription getSubscription(long subscriptionId) throws com.liferay.portal.kernel.exception.PortalException Returns the subscription with the primary key.- Parameters:
subscriptionId- the primary key of the subscription- Returns:
- the subscription
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a subscription with the primary key could not be found
-
getSubscription
public static Subscription getSubscription(long companyId, long userId, String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException Returns the subscription of the user to the entity.- Parameters:
companyId- the primary key of the companyuserId- the primary key of the userclassName- the entity's class nameclassPK- the primary key of the entity's instance- Returns:
- the subscription of the user to the entity
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getSubscriptions
Returns a range of all the subscriptions.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.subscription.model.impl.SubscriptionModelImpl.- Parameters:
start- the lower bound of the range of subscriptionsend- the upper bound of the range of subscriptions (not inclusive)- Returns:
- the range of subscriptions
-
getSubscriptions
public static List<Subscription> getSubscriptions(long companyId, long userId, String className, long[] classPKs) Returns all the subscriptions of the user to the entities.- Parameters:
companyId- the primary key of the companyuserId- the primary key of the userclassName- the entity's class nameclassPKs- the primary key of the entities- Returns:
- the subscriptions of the user to the entities
-
getSubscriptions
Returns all the subscriptions to the entity.- Parameters:
companyId- the primary key of the companyclassName- the entity's class nameclassPK- the primary key of the entity's instance- Returns:
- the subscriptions to the entity
-
getSubscriptions
Deprecated.As of Athanasius (7.3.x), with no direct replacement- Parameters:
className- the entity's class name- Returns:
- the subscriptions to the class name
-
getSubscriptionsCount
public static int getSubscriptionsCount()Returns the number of subscriptions.- Returns:
- the number of subscriptions
-
getSubscriptionsCount
Deprecated.As of Athanasius (7.3.x), with no direct replacement- Parameters:
className- the entity's class name- Returns:
- the subscriptions to the class name
-
getUserSubscriptions
public static List<Subscription> getUserSubscriptions(long userId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<Subscription> orderByComparator) Returns an ordered range of all the subscriptions of the user.- Parameters:
userId- the primary key of the userstart- the lower bound of the range of resultsend- the upper bound of the range of results (not inclusive)orderByComparator- the comparator to order the subscriptions- Returns:
- the range of subscriptions of the user
-
getUserSubscriptions
Returns all the subscriptions of the user to the entities with the class name.- Parameters:
userId- the primary key of the userclassName- the entity's class name- Returns:
- the subscriptions of the user to the entities with the class name
-
getUserSubscriptionsCount
public static int getUserSubscriptionsCount(long userId) Returns the number of subscriptions of the user.- Parameters:
userId- the primary key of the user- Returns:
- the number of subscriptions of the user
-
isSubscribed
Returnstrueif the user is subscribed to the entity.- Parameters:
companyId- the primary key of the companyuserId- the primary key of the userclassName- the entity's class nameclassPK- the primary key of the entity's instance- Returns:
trueif the user is subscribed to the entity;falseotherwise
-
isSubscribed
Returnstrueif the user is subscribed to any of the entities.- Parameters:
companyId- the primary key of the companyuserId- the primary key of the userclassName- the entity's class nameclassPKs- the primary key of the entities- Returns:
trueif the user is subscribed to any of the entities;falseotherwise
-
updateSubscription
Updates the subscription in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect SubscriptionLocalServiceImpl 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:
subscription- the subscription- Returns:
- the subscription that was updated
-
updateSubscriptions
public static void updateSubscriptions(long companyId, long classNameId, long oldClassPK, long newClassPK) -
getService
-