001 /** 002 * Copyright (c) 2000-2011 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 PersistedModelLocalService { 039 /* 040 * NOTE FOR DEVELOPERS: 041 * 042 * 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. 043 */ 044 045 /** 046 * Adds the team to the database. Also notifies the appropriate model listeners. 047 * 048 * @param team the team 049 * @return the team that was added 050 * @throws SystemException if a system exception occurred 051 */ 052 public com.liferay.portal.model.Team addTeam( 053 com.liferay.portal.model.Team team) 054 throws com.liferay.portal.kernel.exception.SystemException; 055 056 /** 057 * Creates a new team with the primary key. Does not add the team to the database. 058 * 059 * @param teamId the primary key for the new team 060 * @return the new team 061 */ 062 public com.liferay.portal.model.Team createTeam(long teamId); 063 064 /** 065 * Deletes the team with the primary key from the database. Also notifies the appropriate model listeners. 066 * 067 * @param teamId the primary key of the team 068 * @throws PortalException if a team with the primary key could not be found 069 * @throws SystemException if a system exception occurred 070 */ 071 public void deleteTeam(long teamId) 072 throws com.liferay.portal.kernel.exception.PortalException, 073 com.liferay.portal.kernel.exception.SystemException; 074 075 /** 076 * Deletes the team from the database. Also notifies the appropriate model listeners. 077 * 078 * @param team the team 079 * @throws PortalException 080 * @throws SystemException if a system exception occurred 081 */ 082 public void deleteTeam(com.liferay.portal.model.Team team) 083 throws com.liferay.portal.kernel.exception.PortalException, 084 com.liferay.portal.kernel.exception.SystemException; 085 086 /** 087 * Performs a dynamic query on the database and returns the matching rows. 088 * 089 * @param dynamicQuery the dynamic query 090 * @return the matching rows 091 * @throws SystemException if a system exception occurred 092 */ 093 @SuppressWarnings("rawtypes") 094 public java.util.List dynamicQuery( 095 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 096 throws com.liferay.portal.kernel.exception.SystemException; 097 098 /** 099 * Performs a dynamic query on the database and returns a range of the matching rows. 100 * 101 * <p> 102 * 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. 103 * </p> 104 * 105 * @param dynamicQuery the dynamic query 106 * @param start the lower bound of the range of model instances 107 * @param end the upper bound of the range of model instances (not inclusive) 108 * @return the range of matching rows 109 * @throws SystemException if a system exception occurred 110 */ 111 @SuppressWarnings("rawtypes") 112 public java.util.List dynamicQuery( 113 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 114 int end) throws com.liferay.portal.kernel.exception.SystemException; 115 116 /** 117 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 118 * 119 * <p> 120 * 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. 121 * </p> 122 * 123 * @param dynamicQuery the dynamic query 124 * @param start the lower bound of the range of model instances 125 * @param end the upper bound of the range of model instances (not inclusive) 126 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 127 * @return the ordered range of matching rows 128 * @throws SystemException if a system exception occurred 129 */ 130 @SuppressWarnings("rawtypes") 131 public java.util.List dynamicQuery( 132 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 133 int end, 134 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 135 throws com.liferay.portal.kernel.exception.SystemException; 136 137 /** 138 * Returns the number of rows that match the dynamic query. 139 * 140 * @param dynamicQuery the dynamic query 141 * @return the number of rows that match the dynamic query 142 * @throws SystemException if a system exception occurred 143 */ 144 public long dynamicQueryCount( 145 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 146 throws com.liferay.portal.kernel.exception.SystemException; 147 148 /** 149 * Returns the team with the primary key. 150 * 151 * @param teamId the primary key of the team 152 * @return the team 153 * @throws PortalException if a team with the primary key could not be found 154 * @throws SystemException if a system exception occurred 155 */ 156 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 157 public com.liferay.portal.model.Team getTeam(long teamId) 158 throws com.liferay.portal.kernel.exception.PortalException, 159 com.liferay.portal.kernel.exception.SystemException; 160 161 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 162 public com.liferay.portal.model.PersistedModel getPersistedModel( 163 java.io.Serializable primaryKeyObj) 164 throws com.liferay.portal.kernel.exception.PortalException, 165 com.liferay.portal.kernel.exception.SystemException; 166 167 /** 168 * Returns a range of all the teams. 169 * 170 * <p> 171 * 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. 172 * </p> 173 * 174 * @param start the lower bound of the range of teams 175 * @param end the upper bound of the range of teams (not inclusive) 176 * @return the range of teams 177 * @throws SystemException if a system exception occurred 178 */ 179 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 180 public java.util.List<com.liferay.portal.model.Team> getTeams(int start, 181 int end) throws com.liferay.portal.kernel.exception.SystemException; 182 183 /** 184 * Returns the number of teams. 185 * 186 * @return the number of teams 187 * @throws SystemException if a system exception occurred 188 */ 189 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 190 public int getTeamsCount() 191 throws com.liferay.portal.kernel.exception.SystemException; 192 193 /** 194 * Updates the team in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 195 * 196 * @param team the team 197 * @return the team that was updated 198 * @throws SystemException if a system exception occurred 199 */ 200 public com.liferay.portal.model.Team updateTeam( 201 com.liferay.portal.model.Team team) 202 throws com.liferay.portal.kernel.exception.SystemException; 203 204 /** 205 * Updates the team in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 206 * 207 * @param team the team 208 * @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. 209 * @return the team that was updated 210 * @throws SystemException if a system exception occurred 211 */ 212 public com.liferay.portal.model.Team updateTeam( 213 com.liferay.portal.model.Team team, boolean merge) 214 throws com.liferay.portal.kernel.exception.SystemException; 215 216 /** 217 * Returns the Spring bean ID for this bean. 218 * 219 * @return the Spring bean ID for this bean 220 */ 221 public java.lang.String getBeanIdentifier(); 222 223 /** 224 * Sets the Spring bean ID for this bean. 225 * 226 * @param beanIdentifier the Spring bean ID for this bean 227 */ 228 public void setBeanIdentifier(java.lang.String beanIdentifier); 229 230 public com.liferay.portal.model.Team addTeam(long userId, long groupId, 231 java.lang.String name, java.lang.String description) 232 throws com.liferay.portal.kernel.exception.PortalException, 233 com.liferay.portal.kernel.exception.SystemException; 234 235 public void deleteTeams(long groupId) 236 throws com.liferay.portal.kernel.exception.PortalException, 237 com.liferay.portal.kernel.exception.SystemException; 238 239 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 240 public java.util.List<com.liferay.portal.model.Team> getGroupTeams( 241 long groupId) 242 throws com.liferay.portal.kernel.exception.SystemException; 243 244 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 245 public com.liferay.portal.model.Team getTeam(long groupId, 246 java.lang.String name) 247 throws com.liferay.portal.kernel.exception.PortalException, 248 com.liferay.portal.kernel.exception.SystemException; 249 250 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 251 public java.util.List<com.liferay.portal.model.Team> getUserTeams( 252 long userId) throws com.liferay.portal.kernel.exception.SystemException; 253 254 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 255 public java.util.List<com.liferay.portal.model.Team> getUserTeams( 256 long userId, long groupId) 257 throws com.liferay.portal.kernel.exception.SystemException; 258 259 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 260 public boolean hasUserTeam(long userId, long teamId) 261 throws com.liferay.portal.kernel.exception.SystemException; 262 263 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 264 public java.util.List<com.liferay.portal.model.Team> search(long groupId, 265 java.lang.String name, java.lang.String description, 266 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 267 int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc) 268 throws com.liferay.portal.kernel.exception.SystemException; 269 270 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 271 public int searchCount(long groupId, java.lang.String name, 272 java.lang.String description, 273 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params) 274 throws com.liferay.portal.kernel.exception.SystemException; 275 276 public com.liferay.portal.model.Team updateTeam(long teamId, 277 java.lang.String name, java.lang.String description) 278 throws com.liferay.portal.kernel.exception.PortalException, 279 com.liferay.portal.kernel.exception.SystemException; 280 }