001    /**
002     * Copyright (c) 2000-2013 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 team 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 TeamLocalServiceUtil
032     * @see com.liferay.portal.service.base.TeamLocalServiceBaseImpl
033     * @see com.liferay.portal.service.impl.TeamLocalServiceImpl
034     * @generated
035     */
036    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
037            PortalException.class, SystemException.class})
038    public interface TeamLocalService extends BaseLocalService,
039            PersistedModelLocalService {
040            /*
041             * NOTE FOR DEVELOPERS:
042             *
043             * Never modify or reference this interface directly. Always use {@link TeamLocalServiceUtil} to access the team local service. Add custom service methods to {@link com.liferay.portal.service.impl.TeamLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
044             */
045    
046            /**
047            * Adds the team to the database. Also notifies the appropriate model listeners.
048            *
049            * @param team the team
050            * @return the team that was added
051            * @throws SystemException if a system exception occurred
052            */
053            public com.liferay.portal.model.Team addTeam(
054                    com.liferay.portal.model.Team team)
055                    throws com.liferay.portal.kernel.exception.SystemException;
056    
057            /**
058            * Creates a new team with the primary key. Does not add the team to the database.
059            *
060            * @param teamId the primary key for the new team
061            * @return the new team
062            */
063            public com.liferay.portal.model.Team createTeam(long teamId);
064    
065            /**
066            * Deletes the team with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param teamId the primary key of the team
069            * @return the team that was removed
070            * @throws PortalException if a team with the primary key could not be found
071            * @throws SystemException if a system exception occurred
072            */
073            public com.liferay.portal.model.Team deleteTeam(long teamId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException;
076    
077            /**
078            * Deletes the team from the database. Also notifies the appropriate model listeners.
079            *
080            * @param team the team
081            * @return the team that was removed
082            * @throws PortalException
083            * @throws SystemException if a system exception occurred
084            */
085            public com.liferay.portal.model.Team deleteTeam(
086                    com.liferay.portal.model.Team team)
087                    throws com.liferay.portal.kernel.exception.PortalException,
088                            com.liferay.portal.kernel.exception.SystemException;
089    
090            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
091    
092            /**
093            * Performs a dynamic query on the database and returns the matching rows.
094            *
095            * @param dynamicQuery the dynamic query
096            * @return the matching rows
097            * @throws SystemException if a system exception occurred
098            */
099            @SuppressWarnings("rawtypes")
100            public java.util.List dynamicQuery(
101                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
102                    throws com.liferay.portal.kernel.exception.SystemException;
103    
104            /**
105            * Performs a dynamic query on the database and returns a range of the matching rows.
106            *
107            * <p>
108            * 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.
109            * </p>
110            *
111            * @param dynamicQuery the dynamic query
112            * @param start the lower bound of the range of model instances
113            * @param end the upper bound of the range of model instances (not inclusive)
114            * @return the range of matching rows
115            * @throws SystemException if a system exception occurred
116            */
117            @SuppressWarnings("rawtypes")
118            public java.util.List dynamicQuery(
119                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
120                    int end) throws com.liferay.portal.kernel.exception.SystemException;
121    
122            /**
123            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
124            *
125            * <p>
126            * 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.
127            * </p>
128            *
129            * @param dynamicQuery the dynamic query
130            * @param start the lower bound of the range of model instances
131            * @param end the upper bound of the range of model instances (not inclusive)
132            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
133            * @return the ordered range of matching rows
134            * @throws SystemException if a system exception occurred
135            */
136            @SuppressWarnings("rawtypes")
137            public java.util.List dynamicQuery(
138                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
139                    int end,
140                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
141                    throws com.liferay.portal.kernel.exception.SystemException;
142    
143            /**
144            * Returns the number of rows that match the dynamic query.
145            *
146            * @param dynamicQuery the dynamic query
147            * @return the number of rows that match the dynamic query
148            * @throws SystemException if a system exception occurred
149            */
150            public long dynamicQueryCount(
151                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
152                    throws com.liferay.portal.kernel.exception.SystemException;
153    
154            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
155            public com.liferay.portal.model.Team fetchTeam(long teamId)
156                    throws com.liferay.portal.kernel.exception.SystemException;
157    
158            /**
159            * Returns the team with the primary key.
160            *
161            * @param teamId the primary key of the team
162            * @return the team
163            * @throws PortalException if a team with the primary key could not be found
164            * @throws SystemException if a system exception occurred
165            */
166            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
167            public com.liferay.portal.model.Team getTeam(long teamId)
168                    throws com.liferay.portal.kernel.exception.PortalException,
169                            com.liferay.portal.kernel.exception.SystemException;
170    
171            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
172            public com.liferay.portal.model.PersistedModel getPersistedModel(
173                    java.io.Serializable primaryKeyObj)
174                    throws com.liferay.portal.kernel.exception.PortalException,
175                            com.liferay.portal.kernel.exception.SystemException;
176    
177            /**
178            * Returns a range of all the teams.
179            *
180            * <p>
181            * 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.
182            * </p>
183            *
184            * @param start the lower bound of the range of teams
185            * @param end the upper bound of the range of teams (not inclusive)
186            * @return the range of teams
187            * @throws SystemException if a system exception occurred
188            */
189            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
190            public java.util.List<com.liferay.portal.model.Team> getTeams(int start,
191                    int end) throws com.liferay.portal.kernel.exception.SystemException;
192    
193            /**
194            * Returns the number of teams.
195            *
196            * @return the number of teams
197            * @throws SystemException if a system exception occurred
198            */
199            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
200            public int getTeamsCount()
201                    throws com.liferay.portal.kernel.exception.SystemException;
202    
203            /**
204            * Updates the team in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
205            *
206            * @param team the team
207            * @return the team that was updated
208            * @throws SystemException if a system exception occurred
209            */
210            public com.liferay.portal.model.Team updateTeam(
211                    com.liferay.portal.model.Team team)
212                    throws com.liferay.portal.kernel.exception.SystemException;
213    
214            /**
215            * Updates the team in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
216            *
217            * @param team the team
218            * @param merge whether to merge the team 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.
219            * @return the team that was updated
220            * @throws SystemException if a system exception occurred
221            */
222            public com.liferay.portal.model.Team updateTeam(
223                    com.liferay.portal.model.Team team, boolean merge)
224                    throws com.liferay.portal.kernel.exception.SystemException;
225    
226            /**
227            * @throws SystemException if a system exception occurred
228            */
229            public void addUserTeam(long userId, long teamId)
230                    throws com.liferay.portal.kernel.exception.SystemException;
231    
232            /**
233            * @throws SystemException if a system exception occurred
234            */
235            public void addUserTeam(long userId, com.liferay.portal.model.Team team)
236                    throws com.liferay.portal.kernel.exception.SystemException;
237    
238            /**
239            * @throws SystemException if a system exception occurred
240            */
241            public void addUserTeams(long userId, long[] teamIds)
242                    throws com.liferay.portal.kernel.exception.SystemException;
243    
244            /**
245            * @throws SystemException if a system exception occurred
246            */
247            public void addUserTeams(long userId,
248                    java.util.List<com.liferay.portal.model.Team> Teams)
249                    throws com.liferay.portal.kernel.exception.SystemException;
250    
251            /**
252            * @throws SystemException if a system exception occurred
253            */
254            public void clearUserTeams(long userId)
255                    throws com.liferay.portal.kernel.exception.SystemException;
256    
257            /**
258            * @throws SystemException if a system exception occurred
259            */
260            public void deleteUserTeam(long userId, long teamId)
261                    throws com.liferay.portal.kernel.exception.SystemException;
262    
263            /**
264            * @throws SystemException if a system exception occurred
265            */
266            public void deleteUserTeam(long userId, com.liferay.portal.model.Team team)
267                    throws com.liferay.portal.kernel.exception.SystemException;
268    
269            /**
270            * @throws SystemException if a system exception occurred
271            */
272            public void deleteUserTeams(long userId, long[] teamIds)
273                    throws com.liferay.portal.kernel.exception.SystemException;
274    
275            /**
276            * @throws SystemException if a system exception occurred
277            */
278            public void deleteUserTeams(long userId,
279                    java.util.List<com.liferay.portal.model.Team> Teams)
280                    throws com.liferay.portal.kernel.exception.SystemException;
281    
282            /**
283            * @throws SystemException if a system exception occurred
284            */
285            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
286            public java.util.List<com.liferay.portal.model.Team> getUserTeams(
287                    long userId) throws com.liferay.portal.kernel.exception.SystemException;
288    
289            /**
290            * @throws SystemException if a system exception occurred
291            */
292            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
293            public java.util.List<com.liferay.portal.model.Team> getUserTeams(
294                    long userId, int start, int end)
295                    throws com.liferay.portal.kernel.exception.SystemException;
296    
297            /**
298            * @throws SystemException if a system exception occurred
299            */
300            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
301            public java.util.List<com.liferay.portal.model.Team> getUserTeams(
302                    long userId, int start, int end,
303                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
304                    throws com.liferay.portal.kernel.exception.SystemException;
305    
306            /**
307            * @throws SystemException if a system exception occurred
308            */
309            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
310            public int getUserTeamsCount(long userId)
311                    throws com.liferay.portal.kernel.exception.SystemException;
312    
313            /**
314            * @throws SystemException if a system exception occurred
315            */
316            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
317            public boolean hasUserTeam(long userId, long teamId)
318                    throws com.liferay.portal.kernel.exception.SystemException;
319    
320            /**
321            * @throws SystemException if a system exception occurred
322            */
323            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
324            public boolean hasUserTeams(long userId)
325                    throws com.liferay.portal.kernel.exception.SystemException;
326    
327            /**
328            * @throws SystemException if a system exception occurred
329            */
330            public void setUserTeams(long userId, long[] teamIds)
331                    throws com.liferay.portal.kernel.exception.SystemException;
332    
333            /**
334            * @throws SystemException if a system exception occurred
335            */
336            public void addUserGroupTeam(long userGroupId, long teamId)
337                    throws com.liferay.portal.kernel.exception.SystemException;
338    
339            /**
340            * @throws SystemException if a system exception occurred
341            */
342            public void addUserGroupTeam(long userGroupId,
343                    com.liferay.portal.model.Team team)
344                    throws com.liferay.portal.kernel.exception.SystemException;
345    
346            /**
347            * @throws SystemException if a system exception occurred
348            */
349            public void addUserGroupTeams(long userGroupId, long[] teamIds)
350                    throws com.liferay.portal.kernel.exception.SystemException;
351    
352            /**
353            * @throws SystemException if a system exception occurred
354            */
355            public void addUserGroupTeams(long userGroupId,
356                    java.util.List<com.liferay.portal.model.Team> Teams)
357                    throws com.liferay.portal.kernel.exception.SystemException;
358    
359            /**
360            * @throws SystemException if a system exception occurred
361            */
362            public void clearUserGroupTeams(long userGroupId)
363                    throws com.liferay.portal.kernel.exception.SystemException;
364    
365            /**
366            * @throws SystemException if a system exception occurred
367            */
368            public void deleteUserGroupTeam(long userGroupId, long teamId)
369                    throws com.liferay.portal.kernel.exception.SystemException;
370    
371            /**
372            * @throws SystemException if a system exception occurred
373            */
374            public void deleteUserGroupTeam(long userGroupId,
375                    com.liferay.portal.model.Team team)
376                    throws com.liferay.portal.kernel.exception.SystemException;
377    
378            /**
379            * @throws SystemException if a system exception occurred
380            */
381            public void deleteUserGroupTeams(long userGroupId, long[] teamIds)
382                    throws com.liferay.portal.kernel.exception.SystemException;
383    
384            /**
385            * @throws SystemException if a system exception occurred
386            */
387            public void deleteUserGroupTeams(long userGroupId,
388                    java.util.List<com.liferay.portal.model.Team> Teams)
389                    throws com.liferay.portal.kernel.exception.SystemException;
390    
391            /**
392            * @throws SystemException if a system exception occurred
393            */
394            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
395            public java.util.List<com.liferay.portal.model.Team> getUserGroupTeams(
396                    long userGroupId)
397                    throws com.liferay.portal.kernel.exception.SystemException;
398    
399            /**
400            * @throws SystemException if a system exception occurred
401            */
402            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
403            public java.util.List<com.liferay.portal.model.Team> getUserGroupTeams(
404                    long userGroupId, int start, int end)
405                    throws com.liferay.portal.kernel.exception.SystemException;
406    
407            /**
408            * @throws SystemException if a system exception occurred
409            */
410            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
411            public java.util.List<com.liferay.portal.model.Team> getUserGroupTeams(
412                    long userGroupId, int start, int end,
413                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
414                    throws com.liferay.portal.kernel.exception.SystemException;
415    
416            /**
417            * @throws SystemException if a system exception occurred
418            */
419            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
420            public int getUserGroupTeamsCount(long userGroupId)
421                    throws com.liferay.portal.kernel.exception.SystemException;
422    
423            /**
424            * @throws SystemException if a system exception occurred
425            */
426            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
427            public boolean hasUserGroupTeam(long userGroupId, long teamId)
428                    throws com.liferay.portal.kernel.exception.SystemException;
429    
430            /**
431            * @throws SystemException if a system exception occurred
432            */
433            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
434            public boolean hasUserGroupTeams(long userGroupId)
435                    throws com.liferay.portal.kernel.exception.SystemException;
436    
437            /**
438            * @throws SystemException if a system exception occurred
439            */
440            public void setUserGroupTeams(long userGroupId, long[] teamIds)
441                    throws com.liferay.portal.kernel.exception.SystemException;
442    
443            /**
444            * Returns the Spring bean ID for this bean.
445            *
446            * @return the Spring bean ID for this bean
447            */
448            public java.lang.String getBeanIdentifier();
449    
450            /**
451            * Sets the Spring bean ID for this bean.
452            *
453            * @param beanIdentifier the Spring bean ID for this bean
454            */
455            public void setBeanIdentifier(java.lang.String beanIdentifier);
456    
457            public com.liferay.portal.model.Team addTeam(long userId, long groupId,
458                    java.lang.String name, java.lang.String description)
459                    throws com.liferay.portal.kernel.exception.PortalException,
460                            com.liferay.portal.kernel.exception.SystemException;
461    
462            public void deleteTeams(long groupId)
463                    throws com.liferay.portal.kernel.exception.PortalException,
464                            com.liferay.portal.kernel.exception.SystemException;
465    
466            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
467            public java.util.List<com.liferay.portal.model.Team> getGroupTeams(
468                    long groupId)
469                    throws com.liferay.portal.kernel.exception.SystemException;
470    
471            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
472            public com.liferay.portal.model.Team getTeam(long groupId,
473                    java.lang.String name)
474                    throws com.liferay.portal.kernel.exception.PortalException,
475                            com.liferay.portal.kernel.exception.SystemException;
476    
477            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
478            public java.util.List<com.liferay.portal.model.Team> getUserTeams(
479                    long userId, long groupId)
480                    throws com.liferay.portal.kernel.exception.SystemException;
481    
482            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
483            public java.util.List<com.liferay.portal.model.Team> search(long groupId,
484                    java.lang.String name, java.lang.String description,
485                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
486                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
487                    throws com.liferay.portal.kernel.exception.SystemException;
488    
489            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
490            public int searchCount(long groupId, java.lang.String name,
491                    java.lang.String description,
492                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params)
493                    throws com.liferay.portal.kernel.exception.SystemException;
494    
495            public com.liferay.portal.model.Team updateTeam(long teamId,
496                    java.lang.String name, java.lang.String description)
497                    throws com.liferay.portal.kernel.exception.PortalException,
498                            com.liferay.portal.kernel.exception.SystemException;
499    }