Interface SubscriptionLocalService
- All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService,com.liferay.portal.kernel.service.change.tracking.CTService<Subscription>,com.liferay.portal.kernel.service.PersistedModelLocalService
- All Known Implementing Classes:
SubscriptionLocalServiceWrapper
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionaddSubscription(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.addSubscription(long userId, long groupId, String className, long classPK, String frequency) Subscribes the user to the entity, notifying him at the given frequency.addSubscription(Subscription subscription) Adds the subscription to the database.com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) createSubscription(long subscriptionId) Creates a new subscription with the primary key.voiddeleteGroupSubscriptions(long groupId) com.liferay.portal.kernel.model.PersistedModeldeletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) deleteSubscription(long subscriptionId) Deletes the subscription with the primary key from the database.voiddeleteSubscription(long userId, String className, long classPK) Deletes the user's subscription to the entity.deleteSubscription(Subscription subscription) Deletes the subscription from the database.voiddeleteSubscriptions(long userId) Deletes all the subscriptions of the user.voiddeleteSubscriptions(long userId, long groupId) voiddeleteSubscriptions(long companyId, String className, long classPK) Deletes all the subscriptions to the entity.<T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) com.liferay.portal.kernel.dao.orm.DynamicQuery<T> List<T>dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<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.<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.longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.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.fetchSubscription(long subscriptionId) fetchSubscription(long companyId, long userId, String className, long classPK) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerycom.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<Subscription>com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQueryReturns the OSGi service identifier.com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) getSubscription(long subscriptionId) Returns the subscription with the primary key.getSubscription(long companyId, long userId, String className, long classPK) Returns the subscription of the user to the entity.getSubscriptions(int start, int end) Returns a range of all the subscriptions.getSubscriptions(long companyId, long userId, String className, long[] classPKs) Returns all the subscriptions of the user to the entities.getSubscriptions(long companyId, String className, long classPK) Returns all the subscriptions to the entity.getSubscriptions(String className) Deprecated.As of Athanasius (7.3.x), with no direct replacementintReturns the number of subscriptions.intgetSubscriptionsCount(String className) Deprecated.As of Athanasius (7.3.x), with no direct replacementgetUserSubscriptions(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.getUserSubscriptions(long userId, String className) Returns all the subscriptions of the user to the entities with the class name.intgetUserSubscriptionsCount(long userId) Returns the number of subscriptions of the user.booleanisSubscribed(long companyId, long userId, String className, long classPK) Returnstrueif the user is subscribed to the entity.booleanisSubscribed(long companyId, long userId, String className, long[] classPKs) Returnstrueif the user is subscribed to any of the entities.updateSubscription(Subscription subscription) Updates the subscription in the database or adds it if it does not yet exist.voidupdateSubscriptions(long companyId, long classNameId, long oldClassPK, long newClassPK) <R,E extends Throwable>
RupdateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<Subscription>, R, E> updateUnsafeFunction) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addSubscription
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
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
com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
createPersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- 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
void deleteGroupSubscriptions(long groupId) -
deletePersistedModel
com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
deletePersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteSubscription
@Indexable(type=DELETE) 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
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
@Indexable(type=DELETE) @SystemEvent(type=1) 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
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
void deleteSubscriptions(long userId, long groupId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteSubscriptions
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
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCountin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() -
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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(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
@Transactional(propagation=SUPPORTS, readOnly=true) <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
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) Subscription fetchSubscription(long subscriptionId) -
fetchSubscription
@Transactional(propagation=SUPPORTS, readOnly=true) Subscription fetchSubscription(long companyId, long userId, String className, long classPK) -
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getIndexableActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getPersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getSubscription
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) List<Subscription> getSubscriptions(int start, int end) 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
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) List<Subscription> getSubscriptions(long companyId, String className, long classPK) 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 @Transactional(propagation=SUPPORTS, readOnly=true) List<Subscription> getSubscriptions(String className) 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
@Transactional(propagation=SUPPORTS, readOnly=true) int getSubscriptionsCount()Returns the number of subscriptions.- Returns:
- the number of subscriptions
-
getSubscriptionsCount
@Deprecated @Transactional(propagation=SUPPORTS, readOnly=true) int getSubscriptionsCount(String className) 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
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) List<Subscription> getUserSubscriptions(long userId, String className) 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
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) boolean isSubscribed(long companyId, long userId, String className, long classPK) 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
@Transactional(propagation=SUPPORTS, readOnly=true) boolean isSubscribed(long companyId, long userId, String className, long[] classPKs) 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
void updateSubscriptions(long companyId, long classNameId, long oldClassPK, long newClassPK) -
getCTPersistence
@Transactional(enabled=false) com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<Subscription> getCTPersistence()- Specified by:
getCTPersistencein interfacecom.liferay.portal.kernel.service.change.tracking.CTService<Subscription>
-
getModelClass
- Specified by:
getModelClassin interfacecom.liferay.portal.kernel.service.change.tracking.CTService<Subscription>
-
updateWithUnsafeFunction
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<Subscription>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunctionin interfacecom.liferay.portal.kernel.service.change.tracking.CTService<Subscription>- Throws:
E extends Throwable
-