Class SubscriptionLocalServiceWrapper

java.lang.Object
com.liferay.subscription.service.SubscriptionLocalServiceWrapper
All Implemented Interfaces:
com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.change.tracking.CTService<Subscription>, com.liferay.portal.kernel.service.PersistedModelLocalService, com.liferay.portal.kernel.service.ServiceWrapper<SubscriptionLocalService>, SubscriptionLocalService

public class SubscriptionLocalServiceWrapper extends Object implements com.liferay.portal.kernel.service.ServiceWrapper<SubscriptionLocalService>, SubscriptionLocalService
Provides a wrapper for SubscriptionLocalService.
See Also:
Generated:
  • Constructor Details

    • SubscriptionLocalServiceWrapper

      public SubscriptionLocalServiceWrapper()
    • SubscriptionLocalServiceWrapper

      public SubscriptionLocalServiceWrapper(SubscriptionLocalService subscriptionLocalService)
  • Method Details

    • addSubscription

      public 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.

      Specified by:
      addSubscription in interface SubscriptionLocalService
      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

      public 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.

      Specified by:
      addSubscription in interface SubscriptionLocalService
      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

      public 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.

      Specified by:
      addSubscription in interface SubscriptionLocalService
      Parameters:
      subscription - the subscription
      Returns:
      the subscription that was added
    • createPersistedModel

      public 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
      Specified by:
      createPersistedModel in interface SubscriptionLocalService
      Throws:
      PortalException
      com.liferay.portal.kernel.exception.PortalException
    • createSubscription

      public Subscription createSubscription(long subscriptionId)
      Creates a new subscription with the primary key. Does not add the subscription to the database.
      Specified by:
      createSubscription in interface SubscriptionLocalService
      Parameters:
      subscriptionId - the primary key for the new subscription
      Returns:
      the new subscription
    • deleteGroupSubscriptions

      public void deleteGroupSubscriptions(long groupId)
      Specified by:
      deleteGroupSubscriptions in interface SubscriptionLocalService
    • deletePersistedModel

      public 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
      Specified by:
      deletePersistedModel in interface SubscriptionLocalService
      Throws:
      PortalException
      com.liferay.portal.kernel.exception.PortalException
    • deleteSubscription

      public 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.

      Specified by:
      deleteSubscription in interface SubscriptionLocalService
      Parameters:
      subscriptionId - the primary key of the subscription
      Returns:
      the subscription that was removed
      Throws:
      PortalException - if a subscription with the primary key could not be found
      com.liferay.portal.kernel.exception.PortalException
    • deleteSubscription

      public 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.
      Specified by:
      deleteSubscription in interface SubscriptionLocalService
      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

      public 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.

      Specified by:
      deleteSubscription in interface SubscriptionLocalService
      Parameters:
      subscription - the subscription
      Returns:
      the subscription that was removed
      Throws:
      PortalException
      com.liferay.portal.kernel.exception.PortalException
    • deleteSubscriptions

      public void deleteSubscriptions(long userId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes all the subscriptions of the user.
      Specified by:
      deleteSubscriptions in interface SubscriptionLocalService
      Parameters:
      userId - the primary key of the user
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteSubscriptions

      public void deleteSubscriptions(long userId, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      deleteSubscriptions in interface SubscriptionLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteSubscriptions

      public void deleteSubscriptions(long companyId, String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException
      Deletes all the subscriptions to the entity.
      Specified by:
      deleteSubscriptions in interface SubscriptionLocalService
      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

      public <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQuery in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Specified by:
      dslQuery in interface SubscriptionLocalService
    • dslQueryCount

      public int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Specified by:
      dslQueryCount in interface SubscriptionLocalService
    • dynamicQuery

      public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
      Specified by:
      dynamicQuery in interface SubscriptionLocalService
    • dynamicQuery

      public <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
      Performs a dynamic query on the database and returns the matching rows.
      Specified by:
      dynamicQuery in interface SubscriptionLocalService
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the matching rows
    • dynamicQuery

      public <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.

      Specified by:
      dynamicQuery in interface SubscriptionLocalService
      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

      public <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.

      Specified by:
      dynamicQuery in interface SubscriptionLocalService
      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

      public long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
      Returns the number of rows matching the dynamic query.
      Specified by:
      dynamicQueryCount in interface SubscriptionLocalService
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the number of rows matching the dynamic query
    • dynamicQueryCount

      public 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.
      Specified by:
      dynamicQueryCount in interface SubscriptionLocalService
      Parameters:
      dynamicQuery - the dynamic query
      projection - the projection to apply to the query
      Returns:
      the number of rows matching the dynamic query
    • fetchSubscription

      public Subscription fetchSubscription(long subscriptionId)
      Specified by:
      fetchSubscription in interface SubscriptionLocalService
    • fetchSubscription

      public Subscription fetchSubscription(long companyId, long userId, String className, long classPK)
      Specified by:
      fetchSubscription in interface SubscriptionLocalService
    • getActionableDynamicQuery

      public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
      Specified by:
      getActionableDynamicQuery in interface SubscriptionLocalService
    • getIndexableActionableDynamicQuery

      public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
      Specified by:
      getIndexableActionableDynamicQuery in interface SubscriptionLocalService
    • getOSGiServiceIdentifier

      public String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Specified by:
      getOSGiServiceIdentifier in interface SubscriptionLocalService
      Returns:
      the OSGi service identifier
    • getPersistedModel

      public 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
      Specified by:
      getPersistedModel in interface SubscriptionLocalService
      Throws:
      PortalException
      com.liferay.portal.kernel.exception.PortalException
    • getSubscription

      public Subscription getSubscription(long subscriptionId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the subscription with the primary key.
      Specified by:
      getSubscription in interface SubscriptionLocalService
      Parameters:
      subscriptionId - the primary key of the subscription
      Returns:
      the subscription
      Throws:
      PortalException - if a subscription with the primary key could not be found
      com.liferay.portal.kernel.exception.PortalException
    • getSubscription

      public 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.
      Specified by:
      getSubscription in interface SubscriptionLocalService
      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

      public 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.

      Specified by:
      getSubscriptions in interface SubscriptionLocalService
      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

      public List<Subscription> getSubscriptions(long companyId, long userId, String className, long[] classPKs)
      Returns all the subscriptions of the user to the entities.
      Specified by:
      getSubscriptions in interface SubscriptionLocalService
      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

      public List<Subscription> getSubscriptions(long companyId, String className, long classPK)
      Returns all the subscriptions to the entity.
      Specified by:
      getSubscriptions in interface SubscriptionLocalService
      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 public List<Subscription> getSubscriptions(String className)
      Deprecated.
      As of Athanasius (7.3.x), with no direct replacement
      Specified by:
      getSubscriptions in interface SubscriptionLocalService
      Parameters:
      className - the entity's class name
      Returns:
      the subscriptions to the class name
    • getSubscriptionsCount

      public int getSubscriptionsCount()
      Returns the number of subscriptions.
      Specified by:
      getSubscriptionsCount in interface SubscriptionLocalService
      Returns:
      the number of subscriptions
    • getSubscriptionsCount

      @Deprecated public int getSubscriptionsCount(String className)
      Deprecated.
      As of Athanasius (7.3.x), with no direct replacement
      Specified by:
      getSubscriptionsCount in interface SubscriptionLocalService
      Parameters:
      className - the entity's class name
      Returns:
      the subscriptions to the class name
    • getUserSubscriptions

      public 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.
      Specified by:
      getUserSubscriptions in interface SubscriptionLocalService
      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

      public List<Subscription> getUserSubscriptions(long userId, String className)
      Returns all the subscriptions of the user to the entities with the class name.
      Specified by:
      getUserSubscriptions in interface SubscriptionLocalService
      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

      public int getUserSubscriptionsCount(long userId)
      Returns the number of subscriptions of the user.
      Specified by:
      getUserSubscriptionsCount in interface SubscriptionLocalService
      Parameters:
      userId - the primary key of the user
      Returns:
      the number of subscriptions of the user
    • isSubscribed

      public boolean isSubscribed(long companyId, long userId, String className, long classPK)
      Returns true if the user is subscribed to the entity.
      Specified by:
      isSubscribed in interface SubscriptionLocalService
      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

      public boolean isSubscribed(long companyId, long userId, String className, long[] classPKs)
      Returns true if the user is subscribed to any of the entities.
      Specified by:
      isSubscribed in interface SubscriptionLocalService
      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

      public 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.

      Specified by:
      updateSubscription in interface SubscriptionLocalService
      Parameters:
      subscription - the subscription
      Returns:
      the subscription that was updated
    • updateSubscriptions

      public void updateSubscriptions(long companyId, long classNameId, long oldClassPK, long newClassPK)
      Specified by:
      updateSubscriptions in interface SubscriptionLocalService
    • getBasePersistence

      public com.liferay.portal.kernel.service.persistence.BasePersistence<?> getBasePersistence()
      Specified by:
      getBasePersistence in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • getCTPersistence

      public 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>
      Specified by:
      getCTPersistence in interface SubscriptionLocalService
    • getModelClass

      public Class<Subscription> getModelClass()
      Specified by:
      getModelClass in interface com.liferay.portal.kernel.service.change.tracking.CTService<Subscription>
      Specified by:
      getModelClass in interface SubscriptionLocalService
    • updateWithUnsafeFunction

      public <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>
      Specified by:
      updateWithUnsafeFunction in interface SubscriptionLocalService
      Throws:
      E extends Throwable
    • getWrappedService

      public SubscriptionLocalService getWrappedService()
      Specified by:
      getWrappedService in interface com.liferay.portal.kernel.service.ServiceWrapper<SubscriptionLocalService>
    • setWrappedService

      public void setWrappedService(SubscriptionLocalService subscriptionLocalService)
      Specified by:
      setWrappedService in interface com.liferay.portal.kernel.service.ServiceWrapper<SubscriptionLocalService>