Java tutorial
/** * Copyright (c) 2000-present Liferay, Inc. All rights reserved. * * This library is free software; you can redistribute it and/or modify it under * the terms of the GNU Lesser General Public License as published by the Free * Software Foundation; either version 2.1 of the License, or (at your option) * any later version. * * This library is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more * details. */ package com.liferay.portal.kernel.service; import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil; /** * Provides the local service utility for Subscription. This utility wraps * <code>com.liferay.portal.service.impl.SubscriptionLocalServiceImpl</code> 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. * * @author Brian Wing Shun Chan * @see SubscriptionLocalService * @deprecated As of Judson (7.1.x), replaced by {@link com.liferay.subscription.service.impl.SubscriptionLocalServiceImpl} * @generated */ @Deprecated public class SubscriptionLocalServiceUtil { /** * NOTE FOR DEVELOPERS: * * Never modify this class directly. Add custom service methods to <code>com.liferay.portal.service.impl.SubscriptionLocalServiceImpl</code> and rerun ServiceBuilder to regenerate this class. */ /** * Subscribes the user to the entity, notifying him the instant the entity * is created, deleted, or modified. * * <p> * If there is no asset entry with the class name and class PK a new asset * entry is created. * </p> * * <p> * 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. * </p> * * @param userId the primary key of the user * @param groupId the primary key of the entity's group * @param className the entity's class name * @param classPK the primary key of the entity's instance * @return the subscription */ public static com.liferay.portal.kernel.model.Subscription addSubscription(long userId, long groupId, String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException { return getService().addSubscription(userId, groupId, className, classPK); } /** * Subscribes the user to the entity, notifying him at the given frequency. * * <p> * If there is no asset entry with the class name and class PK a new asset * entry is created. * </p> * * <p> * 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. * </p> * * @param userId the primary key of the user * @param groupId the primary key of the entity's group * @param className the entity's class name * @param classPK the primary key of the entity's instance * @param frequency the frequency for notifications * @return the subscription */ public static com.liferay.portal.kernel.model.Subscription addSubscription(long userId, long groupId, String className, long classPK, String frequency) throws com.liferay.portal.kernel.exception.PortalException { return getService().addSubscription(userId, groupId, className, classPK, frequency); } /** * Adds the subscription to the database. Also notifies the appropriate model listeners. * * @param subscription the subscription * @return the subscription that was added */ public static com.liferay.portal.kernel.model.Subscription addSubscription( com.liferay.portal.kernel.model.Subscription subscription) { return getService().addSubscription(subscription); } /** * Creates a new subscription with the primary key. Does not add the subscription to the database. * * @param subscriptionId the primary key for the new subscription * @return the new subscription */ public static com.liferay.portal.kernel.model.Subscription createSubscription(long subscriptionId) { return getService().createSubscription(subscriptionId); } /** * @throws PortalException */ public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel( com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException { return getService().deletePersistedModel(persistedModel); } /** * Deletes the subscription with the primary key from the database. Also notifies the appropriate model listeners. * * @param subscriptionId the primary key of the subscription * @return the subscription that was removed * @throws PortalException if a subscription with the primary key could not be found */ public static com.liferay.portal.kernel.model.Subscription deleteSubscription(long subscriptionId) throws com.liferay.portal.kernel.exception.PortalException { return getService().deleteSubscription(subscriptionId); } /** * Deletes the user's subscription to the entity. A social activity with the * unsubscribe action is created. * * @param userId the primary key of the user * @param className the entity's class name * @param classPK the primary key of the entity's instance */ public static void deleteSubscription(long userId, String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException { getService().deleteSubscription(userId, className, classPK); } /** * Deletes the subscription from the database. Also notifies the appropriate model listeners. * * @param subscription the subscription * @return the subscription that was removed * @throws PortalException */ public static com.liferay.portal.kernel.model.Subscription deleteSubscription( com.liferay.portal.kernel.model.Subscription subscription) throws com.liferay.portal.kernel.exception.PortalException { return getService().deleteSubscription(subscription); } /** * Deletes all the subscriptions of the user. * * @param userId the primary key of the user */ public static void deleteSubscriptions(long userId) throws com.liferay.portal.kernel.exception.PortalException { getService().deleteSubscriptions(userId); } public static void deleteSubscriptions(long userId, long groupId) throws com.liferay.portal.kernel.exception.PortalException { getService().deleteSubscriptions(userId, groupId); } /** * Deletes all the subscriptions to the entity. * * @param companyId the primary key of the company * @param className the entity's class name * @param classPK the primary key of the entity's instance */ public static void deleteSubscriptions(long companyId, String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException { getService().deleteSubscriptions(companyId, className, classPK); } public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() { return getService().dynamicQuery(); } /** * Performs a dynamic query on the database and returns the matching rows. * * @param dynamicQuery the dynamic query * @return the matching rows */ public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) { return getService().dynamicQuery(dynamicQuery); } /** * Performs a dynamic query on the database and returns a range of the matching rows. * * <p> * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to <code>com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS</code> will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent, then the query will include the default ORDER BY logic from <code>com.liferay.portal.model.impl.SubscriptionModelImpl</code>. * </p> * * @param dynamicQuery the dynamic query * @param start the lower bound of the range of model instances * @param end the upper bound of the range of model instances (not inclusive) * @return the range of matching rows */ public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end) { return getService().dynamicQuery(dynamicQuery, start, end); } /** * Performs a dynamic query on the database and returns an ordered range of the matching rows. * * <p> * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to <code>com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS</code> will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent, then the query will include the default ORDER BY logic from <code>com.liferay.portal.model.impl.SubscriptionModelImpl</code>. * </p> * * @param dynamicQuery the dynamic query * @param start the lower bound of the range of model instances * @param end the upper bound of the range of model instances (not inclusive) * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) * @return the ordered range of matching rows */ public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) { return getService().dynamicQuery(dynamicQuery, start, end, orderByComparator); } /** * Returns the number of rows matching the dynamic query. * * @param dynamicQuery the dynamic query * @return the number of rows matching the dynamic query */ public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) { return getService().dynamicQueryCount(dynamicQuery); } /** * Returns the number of rows matching the dynamic query. * * @param dynamicQuery the dynamic query * @param projection the projection to apply to the query * @return the number of rows matching the dynamic query */ public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) { return getService().dynamicQueryCount(dynamicQuery, projection); } public static com.liferay.portal.kernel.model.Subscription fetchSubscription(long subscriptionId) { return getService().fetchSubscription(subscriptionId); } public static com.liferay.portal.kernel.model.Subscription fetchSubscription(long companyId, long userId, String className, long classPK) { return getService().fetchSubscription(companyId, userId, className, classPK); } public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() { return getService().getActionableDynamicQuery(); } public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() { return getService().getIndexableActionableDynamicQuery(); } /** * Returns the OSGi service identifier. * * @return the OSGi service identifier */ public static String getOSGiServiceIdentifier() { return getService().getOSGiServiceIdentifier(); } public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel( java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException { return getService().getPersistedModel(primaryKeyObj); } /** * Returns the subscription with the primary key. * * @param subscriptionId the primary key of the subscription * @return the subscription * @throws PortalException if a subscription with the primary key could not be found */ public static com.liferay.portal.kernel.model.Subscription getSubscription(long subscriptionId) throws com.liferay.portal.kernel.exception.PortalException { return getService().getSubscription(subscriptionId); } /** * Returns the subscription of the user to the entity. * * @param companyId the primary key of the company * @param userId the primary key of the user * @param className the entity's class name * @param classPK the primary key of the entity's instance * @return the subscription of the user to the entity */ public static com.liferay.portal.kernel.model.Subscription getSubscription(long companyId, long userId, String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException { return getService().getSubscription(companyId, userId, className, classPK); } /** * Returns a range of all the subscriptions. * * <p> * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to <code>com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS</code> will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent, then the query will include the default ORDER BY logic from <code>com.liferay.portal.model.impl.SubscriptionModelImpl</code>. * </p> * * @param start the lower bound of the range of subscriptions * @param end the upper bound of the range of subscriptions (not inclusive) * @return the range of subscriptions */ public static java.util.List<com.liferay.portal.kernel.model.Subscription> getSubscriptions(int start, int end) { return getService().getSubscriptions(start, end); } /** * Returns all the subscriptions of the user to the entities. * * @param companyId the primary key of the company * @param userId the primary key of the user * @param className the entity's class name * @param classPKs the primary key of the entities * @return the subscriptions of the user to the entities */ public static java.util.List<com.liferay.portal.kernel.model.Subscription> getSubscriptions(long companyId, long userId, String className, long[] classPKs) { return getService().getSubscriptions(companyId, userId, className, classPKs); } /** * Returns all the subscriptions to the entity. * * @param companyId the primary key of the company * @param className the entity's class name * @param classPK the primary key of the entity's instance * @return the subscriptions to the entity */ public static java.util.List<com.liferay.portal.kernel.model.Subscription> getSubscriptions(long companyId, String className, long classPK) { return getService().getSubscriptions(companyId, className, classPK); } /** * Returns the number of subscriptions. * * @return the number of subscriptions */ public static int getSubscriptionsCount() { return getService().getSubscriptionsCount(); } /** * Returns an ordered range of all the subscriptions of the user. * * @param userId the primary key of the user * @param start the lower bound of the range of results * @param end the upper bound of the range of results (not inclusive) * @param orderByComparator the comparator to order the subscriptions * @return the range of subscriptions of the user */ public static java.util.List<com.liferay.portal.kernel.model.Subscription> getUserSubscriptions(long userId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.Subscription> orderByComparator) { return getService().getUserSubscriptions(userId, start, end, orderByComparator); } /** * Returns all the subscriptions of the user to the entities with the class * name. * * @param userId the primary key of the user * @param className the entity's class name * @return the subscriptions of the user to the entities with the class name */ public static java.util.List<com.liferay.portal.kernel.model.Subscription> getUserSubscriptions(long userId, String className) { return getService().getUserSubscriptions(userId, className); } /** * Returns the number of subscriptions of the user. * * @param userId the primary key of the user * @return the number of subscriptions of the user */ public static int getUserSubscriptionsCount(long userId) { return getService().getUserSubscriptionsCount(userId); } /** * Returns <code>true</code> if the user is subscribed to the entity. * * @param companyId the primary key of the company * @param userId the primary key of the user * @param className the entity's class name * @param classPK the primary key of the entity's instance * @return <code>true</code> if the user is subscribed to the entity; <code>false</code> otherwise */ public static boolean isSubscribed(long companyId, long userId, String className, long classPK) { return getService().isSubscribed(companyId, userId, className, classPK); } /** * Returns <code>true</code> if the user is subscribed to any of the * entities. * * @param companyId the primary key of the company * @param userId the primary key of the user * @param className the entity's class name * @param classPKs the primary key of the entities * @return <code>true</code> if the user is subscribed to any of the entities; <code>false</code> otherwise */ public static boolean isSubscribed(long companyId, long userId, String className, long[] classPKs) { return getService().isSubscribed(companyId, userId, className, classPKs); } /** * Updates the subscription in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. * * @param subscription the subscription * @return the subscription that was updated */ public static com.liferay.portal.kernel.model.Subscription updateSubscription( com.liferay.portal.kernel.model.Subscription subscription) { return getService().updateSubscription(subscription); } public static SubscriptionLocalService getService() { if (_service == null) { _service = (SubscriptionLocalService) PortalBeanLocatorUtil .locate(SubscriptionLocalService.class.getName()); } return _service; } private static SubscriptionLocalService _service; }