001 /** 002 * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved. 003 * 004 * This library is free software; you can redistribute it and/or modify it under 005 * the terms of the GNU Lesser General Public License as published by the Free 006 * Software Foundation; either version 2.1 of the License, or (at your option) 007 * any later version. 008 * 009 * This library is distributed in the hope that it will be useful, but WITHOUT 010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 011 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more 012 * details. 013 */ 014 015 package com.liferay.portal.service; 016 017 import com.liferay.portal.kernel.exception.PortalException; 018 import com.liferay.portal.kernel.exception.SystemException; 019 import com.liferay.portal.kernel.transaction.Isolation; 020 import com.liferay.portal.kernel.transaction.Propagation; 021 import com.liferay.portal.kernel.transaction.Transactional; 022 023 /** 024 * The interface for the subscription local service. 025 * 026 * <p> 027 * This is a local service. 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. 028 * </p> 029 * 030 * @author Brian Wing Shun Chan 031 * @see SubscriptionLocalServiceUtil 032 * @see com.liferay.portal.service.base.SubscriptionLocalServiceBaseImpl 033 * @see com.liferay.portal.service.impl.SubscriptionLocalServiceImpl 034 * @generated 035 */ 036 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 037 PortalException.class, SystemException.class}) 038 public interface SubscriptionLocalService extends PersistedModelLocalService { 039 /* 040 * NOTE FOR DEVELOPERS: 041 * 042 * Never modify or reference this interface directly. Always use {@link SubscriptionLocalServiceUtil} to access the subscription local service. Add custom service methods to {@link com.liferay.portal.service.impl.SubscriptionLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 043 */ 044 045 /** 046 * Adds the subscription to the database. Also notifies the appropriate model listeners. 047 * 048 * @param subscription the subscription 049 * @return the subscription that was added 050 * @throws SystemException if a system exception occurred 051 */ 052 public com.liferay.portal.model.Subscription addSubscription( 053 com.liferay.portal.model.Subscription subscription) 054 throws com.liferay.portal.kernel.exception.SystemException; 055 056 /** 057 * Creates a new subscription with the primary key. Does not add the subscription to the database. 058 * 059 * @param subscriptionId the primary key for the new subscription 060 * @return the new subscription 061 */ 062 public com.liferay.portal.model.Subscription createSubscription( 063 long subscriptionId); 064 065 /** 066 * Deletes the subscription with the primary key from the database. Also notifies the appropriate model listeners. 067 * 068 * @param subscriptionId the primary key of the subscription 069 * @throws PortalException if a subscription with the primary key could not be found 070 * @throws SystemException if a system exception occurred 071 */ 072 public void deleteSubscription(long subscriptionId) 073 throws com.liferay.portal.kernel.exception.PortalException, 074 com.liferay.portal.kernel.exception.SystemException; 075 076 /** 077 * Deletes the subscription from the database. Also notifies the appropriate model listeners. 078 * 079 * @param subscription the subscription 080 * @throws PortalException 081 * @throws SystemException if a system exception occurred 082 */ 083 public void deleteSubscription( 084 com.liferay.portal.model.Subscription subscription) 085 throws com.liferay.portal.kernel.exception.PortalException, 086 com.liferay.portal.kernel.exception.SystemException; 087 088 /** 089 * Performs a dynamic query on the database and returns the matching rows. 090 * 091 * @param dynamicQuery the dynamic query 092 * @return the matching rows 093 * @throws SystemException if a system exception occurred 094 */ 095 @SuppressWarnings("rawtypes") 096 public java.util.List dynamicQuery( 097 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 098 throws com.liferay.portal.kernel.exception.SystemException; 099 100 /** 101 * Performs a dynamic query on the database and returns a range of the matching rows. 102 * 103 * <p> 104 * 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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. 105 * </p> 106 * 107 * @param dynamicQuery the dynamic query 108 * @param start the lower bound of the range of model instances 109 * @param end the upper bound of the range of model instances (not inclusive) 110 * @return the range of matching rows 111 * @throws SystemException if a system exception occurred 112 */ 113 @SuppressWarnings("rawtypes") 114 public java.util.List dynamicQuery( 115 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 116 int end) throws com.liferay.portal.kernel.exception.SystemException; 117 118 /** 119 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 120 * 121 * <p> 122 * 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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. 123 * </p> 124 * 125 * @param dynamicQuery the dynamic query 126 * @param start the lower bound of the range of model instances 127 * @param end the upper bound of the range of model instances (not inclusive) 128 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 129 * @return the ordered range of matching rows 130 * @throws SystemException if a system exception occurred 131 */ 132 @SuppressWarnings("rawtypes") 133 public java.util.List dynamicQuery( 134 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 135 int end, 136 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 137 throws com.liferay.portal.kernel.exception.SystemException; 138 139 /** 140 * Returns the number of rows that match the dynamic query. 141 * 142 * @param dynamicQuery the dynamic query 143 * @return the number of rows that match the dynamic query 144 * @throws SystemException if a system exception occurred 145 */ 146 public long dynamicQueryCount( 147 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 148 throws com.liferay.portal.kernel.exception.SystemException; 149 150 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 151 public com.liferay.portal.model.Subscription fetchSubscription( 152 long subscriptionId) 153 throws com.liferay.portal.kernel.exception.SystemException; 154 155 /** 156 * Returns the subscription with the primary key. 157 * 158 * @param subscriptionId the primary key of the subscription 159 * @return the subscription 160 * @throws PortalException if a subscription with the primary key could not be found 161 * @throws SystemException if a system exception occurred 162 */ 163 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 164 public com.liferay.portal.model.Subscription getSubscription( 165 long subscriptionId) 166 throws com.liferay.portal.kernel.exception.PortalException, 167 com.liferay.portal.kernel.exception.SystemException; 168 169 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 170 public com.liferay.portal.model.PersistedModel getPersistedModel( 171 java.io.Serializable primaryKeyObj) 172 throws com.liferay.portal.kernel.exception.PortalException, 173 com.liferay.portal.kernel.exception.SystemException; 174 175 /** 176 * Returns a range of all the subscriptions. 177 * 178 * <p> 179 * 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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. 180 * </p> 181 * 182 * @param start the lower bound of the range of subscriptions 183 * @param end the upper bound of the range of subscriptions (not inclusive) 184 * @return the range of subscriptions 185 * @throws SystemException if a system exception occurred 186 */ 187 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 188 public java.util.List<com.liferay.portal.model.Subscription> getSubscriptions( 189 int start, int end) 190 throws com.liferay.portal.kernel.exception.SystemException; 191 192 /** 193 * Returns the number of subscriptions. 194 * 195 * @return the number of subscriptions 196 * @throws SystemException if a system exception occurred 197 */ 198 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 199 public int getSubscriptionsCount() 200 throws com.liferay.portal.kernel.exception.SystemException; 201 202 /** 203 * Updates the subscription in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 204 * 205 * @param subscription the subscription 206 * @return the subscription that was updated 207 * @throws SystemException if a system exception occurred 208 */ 209 public com.liferay.portal.model.Subscription updateSubscription( 210 com.liferay.portal.model.Subscription subscription) 211 throws com.liferay.portal.kernel.exception.SystemException; 212 213 /** 214 * Updates the subscription in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 215 * 216 * @param subscription the subscription 217 * @param merge whether to merge the subscription with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation. 218 * @return the subscription that was updated 219 * @throws SystemException if a system exception occurred 220 */ 221 public com.liferay.portal.model.Subscription updateSubscription( 222 com.liferay.portal.model.Subscription subscription, boolean merge) 223 throws com.liferay.portal.kernel.exception.SystemException; 224 225 /** 226 * Returns the Spring bean ID for this bean. 227 * 228 * @return the Spring bean ID for this bean 229 */ 230 public java.lang.String getBeanIdentifier(); 231 232 /** 233 * Sets the Spring bean ID for this bean. 234 * 235 * @param beanIdentifier the Spring bean ID for this bean 236 */ 237 public void setBeanIdentifier(java.lang.String beanIdentifier); 238 239 public com.liferay.portal.model.Subscription addSubscription(long userId, 240 long groupId, java.lang.String className, long classPK) 241 throws com.liferay.portal.kernel.exception.PortalException, 242 com.liferay.portal.kernel.exception.SystemException; 243 244 public com.liferay.portal.model.Subscription addSubscription(long userId, 245 long groupId, java.lang.String className, long classPK, 246 java.lang.String frequency) 247 throws com.liferay.portal.kernel.exception.PortalException, 248 com.liferay.portal.kernel.exception.SystemException; 249 250 public void deleteSubscription(long userId, java.lang.String className, 251 long classPK) 252 throws com.liferay.portal.kernel.exception.PortalException, 253 com.liferay.portal.kernel.exception.SystemException; 254 255 public void deleteSubscriptions(long userId) 256 throws com.liferay.portal.kernel.exception.PortalException, 257 com.liferay.portal.kernel.exception.SystemException; 258 259 public void deleteSubscriptions(long companyId, java.lang.String className, 260 long classPK) 261 throws com.liferay.portal.kernel.exception.PortalException, 262 com.liferay.portal.kernel.exception.SystemException; 263 264 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 265 public com.liferay.portal.model.Subscription getSubscription( 266 long companyId, long userId, java.lang.String className, long classPK) 267 throws com.liferay.portal.kernel.exception.PortalException, 268 com.liferay.portal.kernel.exception.SystemException; 269 270 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 271 public java.util.List<com.liferay.portal.model.Subscription> getSubscriptions( 272 long companyId, java.lang.String className, long classPK) 273 throws com.liferay.portal.kernel.exception.SystemException; 274 275 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 276 public java.util.List<com.liferay.portal.model.Subscription> getUserSubscriptions( 277 long userId, int start, int end, 278 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 279 throws com.liferay.portal.kernel.exception.SystemException; 280 281 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 282 public java.util.List<com.liferay.portal.model.Subscription> getUserSubscriptions( 283 long userId, java.lang.String className) 284 throws com.liferay.portal.kernel.exception.SystemException; 285 286 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 287 public int getUserSubscriptionsCount(long userId) 288 throws com.liferay.portal.kernel.exception.SystemException; 289 290 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 291 public boolean isSubscribed(long companyId, long userId, 292 java.lang.String className, long classPK) 293 throws com.liferay.portal.kernel.exception.SystemException; 294 }