001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
013     */
014    
015    package com.liferay.portlet.social.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    import com.liferay.portal.service.PersistedModelLocalService;
023    
024    /**
025     * The interface for the social equity log local service.
026     *
027     * <p>
028     * 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.
029     * </p>
030     *
031     * @author Brian Wing Shun Chan
032     * @see SocialEquityLogLocalServiceUtil
033     * @see com.liferay.portlet.social.service.base.SocialEquityLogLocalServiceBaseImpl
034     * @see com.liferay.portlet.social.service.impl.SocialEquityLogLocalServiceImpl
035     * @generated
036     */
037    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
038            PortalException.class, SystemException.class})
039    public interface SocialEquityLogLocalService extends PersistedModelLocalService {
040            /*
041             * NOTE FOR DEVELOPERS:
042             *
043             * Never modify or reference this interface directly. Always use {@link SocialEquityLogLocalServiceUtil} to access the social equity log local service. Add custom service methods to {@link com.liferay.portlet.social.service.impl.SocialEquityLogLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
044             */
045    
046            /**
047            * Adds the social equity log to the database. Also notifies the appropriate model listeners.
048            *
049            * @param socialEquityLog the social equity log
050            * @return the social equity log that was added
051            * @throws SystemException if a system exception occurred
052            */
053            public com.liferay.portlet.social.model.SocialEquityLog addSocialEquityLog(
054                    com.liferay.portlet.social.model.SocialEquityLog socialEquityLog)
055                    throws com.liferay.portal.kernel.exception.SystemException;
056    
057            /**
058            * Creates a new social equity log with the primary key. Does not add the social equity log to the database.
059            *
060            * @param equityLogId the primary key for the new social equity log
061            * @return the new social equity log
062            */
063            public com.liferay.portlet.social.model.SocialEquityLog createSocialEquityLog(
064                    long equityLogId);
065    
066            /**
067            * Deletes the social equity log with the primary key from the database. Also notifies the appropriate model listeners.
068            *
069            * @param equityLogId the primary key of the social equity log
070            * @throws PortalException if a social equity log with the primary key could not be found
071            * @throws SystemException if a system exception occurred
072            */
073            public void deleteSocialEquityLog(long equityLogId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException;
076    
077            /**
078            * Deletes the social equity log from the database. Also notifies the appropriate model listeners.
079            *
080            * @param socialEquityLog the social equity log
081            * @throws SystemException if a system exception occurred
082            */
083            public void deleteSocialEquityLog(
084                    com.liferay.portlet.social.model.SocialEquityLog socialEquityLog)
085                    throws com.liferay.portal.kernel.exception.SystemException;
086    
087            /**
088            * Performs a dynamic query on the database and returns the matching rows.
089            *
090            * @param dynamicQuery the dynamic query
091            * @return the matching rows
092            * @throws SystemException if a system exception occurred
093            */
094            @SuppressWarnings("rawtypes")
095            public java.util.List dynamicQuery(
096                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
097                    throws com.liferay.portal.kernel.exception.SystemException;
098    
099            /**
100            * Performs a dynamic query on the database and returns a range of the matching rows.
101            *
102            * <p>
103            * 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.
104            * </p>
105            *
106            * @param dynamicQuery the dynamic query
107            * @param start the lower bound of the range of model instances
108            * @param end the upper bound of the range of model instances (not inclusive)
109            * @return the range of matching rows
110            * @throws SystemException if a system exception occurred
111            */
112            @SuppressWarnings("rawtypes")
113            public java.util.List dynamicQuery(
114                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
115                    int end) throws com.liferay.portal.kernel.exception.SystemException;
116    
117            /**
118            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
119            *
120            * <p>
121            * 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.
122            * </p>
123            *
124            * @param dynamicQuery the dynamic query
125            * @param start the lower bound of the range of model instances
126            * @param end the upper bound of the range of model instances (not inclusive)
127            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
128            * @return the ordered range of matching rows
129            * @throws SystemException if a system exception occurred
130            */
131            @SuppressWarnings("rawtypes")
132            public java.util.List dynamicQuery(
133                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
134                    int end,
135                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
136                    throws com.liferay.portal.kernel.exception.SystemException;
137    
138            /**
139            * Returns the number of rows that match the dynamic query.
140            *
141            * @param dynamicQuery the dynamic query
142            * @return the number of rows that match the dynamic query
143            * @throws SystemException if a system exception occurred
144            */
145            public long dynamicQueryCount(
146                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
147                    throws com.liferay.portal.kernel.exception.SystemException;
148    
149            /**
150            * Returns the social equity log with the primary key.
151            *
152            * @param equityLogId the primary key of the social equity log
153            * @return the social equity log
154            * @throws PortalException if a social equity log with the primary key could not be found
155            * @throws SystemException if a system exception occurred
156            */
157            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
158            public com.liferay.portlet.social.model.SocialEquityLog getSocialEquityLog(
159                    long equityLogId)
160                    throws com.liferay.portal.kernel.exception.PortalException,
161                            com.liferay.portal.kernel.exception.SystemException;
162    
163            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
164            public com.liferay.portal.model.PersistedModel getPersistedModel(
165                    java.io.Serializable primaryKeyObj)
166                    throws com.liferay.portal.kernel.exception.PortalException,
167                            com.liferay.portal.kernel.exception.SystemException;
168    
169            /**
170            * Returns a range of all the social equity logs.
171            *
172            * <p>
173            * 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.
174            * </p>
175            *
176            * @param start the lower bound of the range of social equity logs
177            * @param end the upper bound of the range of social equity logs (not inclusive)
178            * @return the range of social equity logs
179            * @throws SystemException if a system exception occurred
180            */
181            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
182            public java.util.List<com.liferay.portlet.social.model.SocialEquityLog> getSocialEquityLogs(
183                    int start, int end)
184                    throws com.liferay.portal.kernel.exception.SystemException;
185    
186            /**
187            * Returns the number of social equity logs.
188            *
189            * @return the number of social equity logs
190            * @throws SystemException if a system exception occurred
191            */
192            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
193            public int getSocialEquityLogsCount()
194                    throws com.liferay.portal.kernel.exception.SystemException;
195    
196            /**
197            * Updates the social equity log in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
198            *
199            * @param socialEquityLog the social equity log
200            * @return the social equity log that was updated
201            * @throws SystemException if a system exception occurred
202            */
203            public com.liferay.portlet.social.model.SocialEquityLog updateSocialEquityLog(
204                    com.liferay.portlet.social.model.SocialEquityLog socialEquityLog)
205                    throws com.liferay.portal.kernel.exception.SystemException;
206    
207            /**
208            * Updates the social equity log in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
209            *
210            * @param socialEquityLog the social equity log
211            * @param merge whether to merge the social equity log 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.
212            * @return the social equity log that was updated
213            * @throws SystemException if a system exception occurred
214            */
215            public com.liferay.portlet.social.model.SocialEquityLog updateSocialEquityLog(
216                    com.liferay.portlet.social.model.SocialEquityLog socialEquityLog,
217                    boolean merge)
218                    throws com.liferay.portal.kernel.exception.SystemException;
219    
220            /**
221            * Returns the Spring bean ID for this bean.
222            *
223            * @return the Spring bean ID for this bean
224            */
225            public java.lang.String getBeanIdentifier();
226    
227            /**
228            * Sets the Spring bean ID for this bean.
229            *
230            * @param beanIdentifier the Spring bean ID for this bean
231            */
232            public void setBeanIdentifier(java.lang.String beanIdentifier);
233    
234            /**
235            * @deprecated {@link #addEquityLogs(long, long, String, String)}
236            */
237            public void addEquityLogs(long userId, long assetEntryId,
238                    java.lang.String actionId)
239                    throws com.liferay.portal.kernel.exception.PortalException,
240                            com.liferay.portal.kernel.exception.SystemException;
241    
242            public void addEquityLogs(long userId, long assetEntryId,
243                    java.lang.String actionId, java.lang.String extraData)
244                    throws com.liferay.portal.kernel.exception.PortalException,
245                            com.liferay.portal.kernel.exception.SystemException;
246    
247            public void addEquityLogs(long userId, java.lang.String className,
248                    long classPK, java.lang.String actionId, java.lang.String extraData)
249                    throws com.liferay.portal.kernel.exception.PortalException,
250                            com.liferay.portal.kernel.exception.SystemException;
251    
252            public void addSocialEquityAssetEntry(
253                    com.liferay.portlet.asset.model.AssetEntry assetEntry)
254                    throws com.liferay.portal.kernel.exception.SystemException;
255    
256            public void addSocialEquityUser(long groupId,
257                    com.liferay.portal.model.User user)
258                    throws com.liferay.portal.kernel.exception.SystemException;
259    
260            public void checkEquityLogs()
261                    throws com.liferay.portal.kernel.exception.SystemException;
262    
263            public void deactivateEquityLogs(long assetEntryId)
264                    throws com.liferay.portal.kernel.exception.SystemException;
265    
266            /**
267            * @deprecated {@link #deactivateEquityLogs(long, long, String, String)}
268            */
269            public void deactivateEquityLogs(long userId, long assetEntryId,
270                    java.lang.String actionId)
271                    throws com.liferay.portal.kernel.exception.PortalException,
272                            com.liferay.portal.kernel.exception.SystemException;
273    
274            /**
275            * @deprecated {@link #deactivateEquityLogs(long, String, long, String,
276            String)}
277            */
278            public void deactivateEquityLogs(long userId, java.lang.String className,
279                    long classPK, java.lang.String actionId)
280                    throws com.liferay.portal.kernel.exception.PortalException,
281                            com.liferay.portal.kernel.exception.SystemException;
282    
283            public void deactivateEquityLogs(long userId, java.lang.String className,
284                    long classPK, java.lang.String actionId, java.lang.String extraData)
285                    throws com.liferay.portal.kernel.exception.PortalException,
286                            com.liferay.portal.kernel.exception.SystemException;
287    
288            public void deactivateEquityLogs(java.lang.String className, long classPK,
289                    java.lang.String actionId, java.lang.String extraData)
290                    throws com.liferay.portal.kernel.exception.PortalException,
291                            com.liferay.portal.kernel.exception.SystemException;
292    
293            public void deactivateUserEquityLogs(long userId)
294                    throws com.liferay.portal.kernel.exception.SystemException;
295    
296            public void incrementSocialEquityAssetEntry_IQ(long assetEntryId,
297                    com.liferay.portlet.social.model.SocialEquityIncrementPayload equityPayload)
298                    throws com.liferay.portal.kernel.exception.SystemException;
299    
300            public void incrementSocialEquityUser_CQ(long groupId, long userId,
301                    com.liferay.portlet.social.model.SocialEquityIncrementPayload equityPayload)
302                    throws com.liferay.portal.kernel.exception.SystemException;
303    
304            public void incrementSocialEquityUser_PQ(long groupId, long userId,
305                    com.liferay.portlet.social.model.SocialEquityIncrementPayload equityPayload)
306                    throws com.liferay.portal.kernel.exception.SystemException;
307    
308            public void updateRanks();
309    
310            public void updateRanks(long groupId);
311    }