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

@CTAware @ProviderType @Transactional(isolation=PORTAL, rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class}) public interface SubscriptionLocalService extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.change.tracking.CTService<Subscription>, com.liferay.portal.kernel.service.PersistedModelLocalService
Provides the local service interface for Subscription. 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:
  • 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 user
      groupId - the primary key of the entity's group
      className - the entity's class name
      classPK - 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 user
      groupId - the primary key of the entity's group
      className - the entity's class name
      classPK - the primary key of the entity's instance
      frequency - the frequency for notifications
      Returns:
      the subscription
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addSubscription

      @Indexable(type=REINDEX) Subscription addSubscription(Subscription subscription)
      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:
      createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createSubscription

      @Transactional(enabled=false) Subscription createSubscription(long subscriptionId)
      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:
      deletePersistedModel in interface com.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 user
      className - the entity's class name
      classPK - 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 company
      className - the entity's class name
      classPK - 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:
      dslQuery in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dslQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface com.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 - 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.subscription.model.impl.SubscriptionModelImpl.

      Parameters:
      dynamicQuery - the dynamic query
      start - the lower bound of the range of model instances
      end - 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 - 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.subscription.model.impl.SubscriptionModelImpl.

      Parameters:
      dynamicQuery - the dynamic query
      start - the lower bound of the range of model instances
      end - the upper bound of the range of model instances (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      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 query
      projection - 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:
      getPersistedModel in interface com.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 company
      userId - the primary key of the user
      className - the entity's class name
      classPK - 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 - 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.subscription.model.impl.SubscriptionModelImpl.

      Parameters:
      start - the lower bound of the range of subscriptions
      end - 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 company
      userId - the primary key of the user
      className - the entity's class name
      classPKs - 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 company
      className - the entity's class name
      classPK - 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 user
      start - the lower bound of the range of results
      end - 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 user
      className - 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)
      Returns true if the user is subscribed to the entity.
      Parameters:
      companyId - the primary key of the company
      userId - the primary key of the user
      className - the entity's class name
      classPK - the primary key of the entity's instance
      Returns:
      true if the user is subscribed to the entity; false otherwise
    • isSubscribed

      @Transactional(propagation=SUPPORTS, readOnly=true) boolean isSubscribed(long companyId, long userId, String className, long[] classPKs)
      Returns true if the user is subscribed to any of the entities.
      Parameters:
      companyId - the primary key of the company
      userId - the primary key of the user
      className - the entity's class name
      classPKs - the primary key of the entities
      Returns:
      true if the user is subscribed to any of the entities; false otherwise
    • updateSubscription

      @Indexable(type=REINDEX) Subscription updateSubscription(Subscription subscription)
      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:
      getCTPersistence in interface com.liferay.portal.kernel.service.change.tracking.CTService<Subscription>
    • getModelClass

      @Transactional(enabled=false) Class<Subscription> getModelClass()
      Specified by:
      getModelClass in interface com.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,E> updateUnsafeFunction) throws E
      Specified by:
      updateWithUnsafeFunction in interface com.liferay.portal.kernel.service.change.tracking.CTService<Subscription>
      Throws:
      E extends Throwable