Class SubscriptionLocalServiceWrapper

Object
com.liferay.portal.kernel.service.SubscriptionLocalServiceWrapper
All Implemented Interfaces:
BaseLocalService, PersistedModelLocalService, ServiceWrapper<SubscriptionLocalService>, SubscriptionLocalService

@Deprecated public class SubscriptionLocalServiceWrapper extends Object implements ServiceWrapper<SubscriptionLocalService>, SubscriptionLocalService
Deprecated.
As of Judson (7.1.x), replaced by com.liferay.subscription.service.impl.SubscriptionLocalServiceImpl
Provides a wrapper for SubscriptionLocalService.
Author:
Brian Wing Shun Chan
See Also:
{$generated.description}
  • Constructor Details

    • SubscriptionLocalServiceWrapper

      public SubscriptionLocalServiceWrapper()
      Deprecated.
    • SubscriptionLocalServiceWrapper

      public SubscriptionLocalServiceWrapper(SubscriptionLocalService subscriptionLocalService)
      Deprecated.
  • Method Details

    • addSubscription

      public Subscription addSubscription(long userId, long groupId, String className, long classPK) throws PortalException
      Deprecated.
      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:
      PortalException
    • addSubscription

      public Subscription addSubscription(long userId, long groupId, String className, long classPK, String frequency) throws PortalException
      Deprecated.
      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:
      PortalException
    • addSubscription

      public Subscription addSubscription(Subscription subscription)
      Deprecated.
      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 PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Deprecated.
      Specified by:
      createPersistedModel in interface PersistedModelLocalService
      Specified by:
      createPersistedModel in interface SubscriptionLocalService
      Throws:
      PortalException
      PortalException
    • createSubscription

      public Subscription createSubscription(long subscriptionId)
      Deprecated.
      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
    • deletePersistedModel

      public PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
      Deprecated.
      Specified by:
      deletePersistedModel in interface PersistedModelLocalService
      Specified by:
      deletePersistedModel in interface SubscriptionLocalService
      Throws:
      PortalException
      PortalException
    • deleteSubscription

      public Subscription deleteSubscription(long subscriptionId) throws PortalException
      Deprecated.
      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
      PortalException
    • deleteSubscription

      public void deleteSubscription(long userId, String className, long classPK) throws PortalException
      Deprecated.
      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:
      PortalException
    • deleteSubscription

      public Subscription deleteSubscription(Subscription subscription) throws PortalException
      Deprecated.
      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
      PortalException
    • deleteSubscriptions

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

      public void deleteSubscriptions(long userId, long groupId) throws PortalException
      Deprecated.
      Specified by:
      deleteSubscriptions in interface SubscriptionLocalService
      Throws:
      PortalException
    • deleteSubscriptions

      public void deleteSubscriptions(long companyId, String className, long classPK) throws PortalException
      Deprecated.
      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:
      PortalException
    • dslQuery

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

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

      public DynamicQuery dynamicQuery()
      Deprecated.
      Specified by:
      dynamicQuery in interface SubscriptionLocalService
    • dynamicQuery

      public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
      Deprecated.
      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(DynamicQuery dynamicQuery, int start, int end)
      Deprecated.
      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.portal.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(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)
      Deprecated.
      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.portal.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(DynamicQuery dynamicQuery)
      Deprecated.
      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(DynamicQuery dynamicQuery, Projection projection)
      Deprecated.
      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)
      Deprecated.
      Specified by:
      fetchSubscription in interface SubscriptionLocalService
    • fetchSubscription

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

      public ActionableDynamicQuery getActionableDynamicQuery()
      Deprecated.
      Specified by:
      getActionableDynamicQuery in interface SubscriptionLocalService
    • getIndexableActionableDynamicQuery

      public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
      Deprecated.
      Specified by:
      getIndexableActionableDynamicQuery in interface SubscriptionLocalService
    • getOSGiServiceIdentifier

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

      public PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
      Deprecated.
      Specified by:
      getPersistedModel in interface PersistedModelLocalService
      Specified by:
      getPersistedModel in interface SubscriptionLocalService
      Throws:
      PortalException
      PortalException
    • getSubscription

      public Subscription getSubscription(long subscriptionId) throws PortalException
      Deprecated.
      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
      PortalException
    • getSubscription

      public Subscription getSubscription(long companyId, long userId, String className, long classPK) throws PortalException
      Deprecated.
      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:
      PortalException
    • getSubscriptions

      public List<Subscription> getSubscriptions(int start, int end)
      Deprecated.
      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.portal.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)
      Deprecated.
      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)
      Deprecated.
      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
    • getSubscriptionsCount

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

      public List<Subscription> getUserSubscriptions(long userId, int start, int end, OrderByComparator<Subscription> orderByComparator)
      Deprecated.
      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)
      Deprecated.
      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)
      Deprecated.
      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)
      Deprecated.
      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)
      Deprecated.
      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)
      Deprecated.
      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
    • getBasePersistence

      public BasePersistence<?> getBasePersistence()
      Deprecated.
      Specified by:
      getBasePersistence in interface PersistedModelLocalService
    • getWrappedService

      public SubscriptionLocalService getWrappedService()
      Deprecated.
      Specified by:
      getWrappedService in interface ServiceWrapper<SubscriptionLocalService>
    • setWrappedService

      public void setWrappedService(SubscriptionLocalService subscriptionLocalService)
      Deprecated.
      Specified by:
      setWrappedService in interface ServiceWrapper<SubscriptionLocalService>