001 /** 002 * Copyright (c) 2000-2012 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.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 * Returns the Spring bean ID for this bean. 228 * 229 * @return the Spring bean ID for this bean 230 */ 231 public java.lang.String getBeanIdentifier(); 232 233 /** 234 * Sets the Spring bean ID for this bean. 235 * 236 * @param beanIdentifier the Spring bean ID for this bean 237 */ 238 public void setBeanIdentifier(java.lang.String beanIdentifier); 239 240 public com.liferay.portal.model.Team addTeam(long userId, long groupId, 241 java.lang.String name, java.lang.String description) 242 throws com.liferay.portal.kernel.exception.PortalException, 243 com.liferay.portal.kernel.exception.SystemException; 244 245 public void deleteTeams(long groupId) 246 throws com.liferay.portal.kernel.exception.PortalException, 247 com.liferay.portal.kernel.exception.SystemException; 248 249 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 250 public java.util.List<com.liferay.portal.model.Team> getGroupTeams( 251 long groupId) 252 throws com.liferay.portal.kernel.exception.SystemException; 253 254 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 255 public com.liferay.portal.model.Team getTeam(long groupId, 256 java.lang.String name) 257 throws com.liferay.portal.kernel.exception.PortalException, 258 com.liferay.portal.kernel.exception.SystemException; 259 260 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 261 public java.util.List<com.liferay.portal.model.Team> getUserTeams( 262 long userId) throws com.liferay.portal.kernel.exception.SystemException; 263 264 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 265 public java.util.List<com.liferay.portal.model.Team> getUserTeams( 266 long userId, long groupId) 267 throws com.liferay.portal.kernel.exception.SystemException; 268 269 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 270 public boolean hasUserTeam(long userId, long teamId) 271 throws com.liferay.portal.kernel.exception.SystemException; 272 273 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 274 public java.util.List<com.liferay.portal.model.Team> search(long groupId, 275 java.lang.String name, java.lang.String description, 276 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 277 int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc) 278 throws com.liferay.portal.kernel.exception.SystemException; 279 280 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 281 public int searchCount(long groupId, java.lang.String name, 282 java.lang.String description, 283 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params) 284 throws com.liferay.portal.kernel.exception.SystemException; 285 286 public com.liferay.portal.model.Team updateTeam(long teamId, 287 java.lang.String name, java.lang.String description) 288 throws com.liferay.portal.kernel.exception.PortalException, 289 com.liferay.portal.kernel.exception.SystemException; 290 }