001 /** 002 * Copyright (c) 2000-present 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.social.kernel.service; 016 017 import aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery; 020 import com.liferay.portal.kernel.dao.orm.DynamicQuery; 021 import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery; 022 import com.liferay.portal.kernel.dao.orm.Projection; 023 import com.liferay.portal.kernel.exception.PortalException; 024 import com.liferay.portal.kernel.exception.SystemException; 025 import com.liferay.portal.kernel.model.PersistedModel; 026 import com.liferay.portal.kernel.search.Indexable; 027 import com.liferay.portal.kernel.search.IndexableType; 028 import com.liferay.portal.kernel.service.BaseLocalService; 029 import com.liferay.portal.kernel.service.PersistedModelLocalService; 030 import com.liferay.portal.kernel.transaction.Isolation; 031 import com.liferay.portal.kernel.transaction.Propagation; 032 import com.liferay.portal.kernel.transaction.Transactional; 033 import com.liferay.portal.kernel.util.OrderByComparator; 034 035 import com.liferay.social.kernel.model.SocialActivityLimit; 036 037 import java.io.Serializable; 038 039 import java.util.List; 040 041 /** 042 * Provides the local service interface for SocialActivityLimit. Methods of this 043 * service will not have security checks based on the propagated JAAS 044 * credentials because this service can only be accessed from within the same 045 * VM. 046 * 047 * @author Brian Wing Shun Chan 048 * @see SocialActivityLimitLocalServiceUtil 049 * @see com.liferay.portlet.social.service.base.SocialActivityLimitLocalServiceBaseImpl 050 * @see com.liferay.portlet.social.service.impl.SocialActivityLimitLocalServiceImpl 051 * @generated 052 */ 053 @ProviderType 054 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 055 PortalException.class, SystemException.class}) 056 public interface SocialActivityLimitLocalService extends BaseLocalService, 057 PersistedModelLocalService { 058 /* 059 * NOTE FOR DEVELOPERS: 060 * 061 * Never modify or reference this interface directly. Always use {@link SocialActivityLimitLocalServiceUtil} to access the social activity limit local service. Add custom service methods to {@link com.liferay.portlet.social.service.impl.SocialActivityLimitLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 062 */ 063 @Transactional(propagation = Propagation.REQUIRES_NEW) 064 public SocialActivityLimit addActivityLimit(long userId, long groupId, 065 long classNameId, long classPK, int activityType, 066 java.lang.String activityCounterName, int limitPeriod) 067 throws PortalException; 068 069 /** 070 * Adds the social activity limit to the database. Also notifies the appropriate model listeners. 071 * 072 * @param socialActivityLimit the social activity limit 073 * @return the social activity limit that was added 074 */ 075 @Indexable(type = IndexableType.REINDEX) 076 public SocialActivityLimit addSocialActivityLimit( 077 SocialActivityLimit socialActivityLimit); 078 079 /** 080 * Creates a new social activity limit with the primary key. Does not add the social activity limit to the database. 081 * 082 * @param activityLimitId the primary key for the new social activity limit 083 * @return the new social activity limit 084 */ 085 public SocialActivityLimit createSocialActivityLimit(long activityLimitId); 086 087 /** 088 * @throws PortalException 089 */ 090 @Override 091 public PersistedModel deletePersistedModel(PersistedModel persistedModel) 092 throws PortalException; 093 094 /** 095 * Deletes the social activity limit with the primary key from the database. Also notifies the appropriate model listeners. 096 * 097 * @param activityLimitId the primary key of the social activity limit 098 * @return the social activity limit that was removed 099 * @throws PortalException if a social activity limit with the primary key could not be found 100 */ 101 @Indexable(type = IndexableType.DELETE) 102 public SocialActivityLimit deleteSocialActivityLimit(long activityLimitId) 103 throws PortalException; 104 105 /** 106 * Deletes the social activity limit from the database. Also notifies the appropriate model listeners. 107 * 108 * @param socialActivityLimit the social activity limit 109 * @return the social activity limit that was removed 110 */ 111 @Indexable(type = IndexableType.DELETE) 112 public SocialActivityLimit deleteSocialActivityLimit( 113 SocialActivityLimit socialActivityLimit); 114 115 public DynamicQuery dynamicQuery(); 116 117 /** 118 * Performs a dynamic query on the database and returns the matching rows. 119 * 120 * @param dynamicQuery the dynamic query 121 * @return the matching rows 122 */ 123 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery); 124 125 /** 126 * Performs a dynamic query on the database and returns a range of the matching rows. 127 * 128 * <p> 129 * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.social.model.impl.SocialActivityLimitModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 130 * </p> 131 * 132 * @param dynamicQuery the dynamic query 133 * @param start the lower bound of the range of model instances 134 * @param end the upper bound of the range of model instances (not inclusive) 135 * @return the range of matching rows 136 */ 137 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, 138 int end); 139 140 /** 141 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 142 * 143 * <p> 144 * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.social.model.impl.SocialActivityLimitModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 145 * </p> 146 * 147 * @param dynamicQuery the dynamic query 148 * @param start the lower bound of the range of model instances 149 * @param end the upper bound of the range of model instances (not inclusive) 150 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 151 * @return the ordered range of matching rows 152 */ 153 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, 154 int end, OrderByComparator<T> orderByComparator); 155 156 /** 157 * Returns the number of rows matching the dynamic query. 158 * 159 * @param dynamicQuery the dynamic query 160 * @return the number of rows matching the dynamic query 161 */ 162 public long dynamicQueryCount(DynamicQuery dynamicQuery); 163 164 /** 165 * Returns the number of rows matching the dynamic query. 166 * 167 * @param dynamicQuery the dynamic query 168 * @param projection the projection to apply to the query 169 * @return the number of rows matching the dynamic query 170 */ 171 public long dynamicQueryCount(DynamicQuery dynamicQuery, 172 Projection projection); 173 174 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 175 public SocialActivityLimit fetchActivityLimit(long groupId, long userId, 176 long classNameId, long classPK, int activityType, 177 java.lang.String activityCounterName); 178 179 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 180 public SocialActivityLimit fetchSocialActivityLimit(long activityLimitId); 181 182 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 183 public ActionableDynamicQuery getActionableDynamicQuery(); 184 185 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 186 public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery(); 187 188 /** 189 * Returns the OSGi service identifier. 190 * 191 * @return the OSGi service identifier 192 */ 193 public java.lang.String getOSGiServiceIdentifier(); 194 195 @Override 196 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 197 public PersistedModel getPersistedModel(Serializable primaryKeyObj) 198 throws PortalException; 199 200 /** 201 * Returns the social activity limit with the primary key. 202 * 203 * @param activityLimitId the primary key of the social activity limit 204 * @return the social activity limit 205 * @throws PortalException if a social activity limit with the primary key could not be found 206 */ 207 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 208 public SocialActivityLimit getSocialActivityLimit(long activityLimitId) 209 throws PortalException; 210 211 /** 212 * Returns a range of all the social activity limits. 213 * 214 * <p> 215 * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.social.model.impl.SocialActivityLimitModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 216 * </p> 217 * 218 * @param start the lower bound of the range of social activity limits 219 * @param end the upper bound of the range of social activity limits (not inclusive) 220 * @return the range of social activity limits 221 */ 222 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 223 public List<SocialActivityLimit> getSocialActivityLimits(int start, int end); 224 225 /** 226 * Returns the number of social activity limits. 227 * 228 * @return the number of social activity limits 229 */ 230 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 231 public int getSocialActivityLimitsCount(); 232 233 /** 234 * Updates the social activity limit in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 235 * 236 * @param socialActivityLimit the social activity limit 237 * @return the social activity limit that was updated 238 */ 239 @Indexable(type = IndexableType.REINDEX) 240 public SocialActivityLimit updateSocialActivityLimit( 241 SocialActivityLimit socialActivityLimit); 242 }