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 aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.kernel.exception.PortalException; 020 import com.liferay.portal.kernel.exception.SystemException; 021 import com.liferay.portal.kernel.transaction.Isolation; 022 import com.liferay.portal.kernel.transaction.Propagation; 023 import com.liferay.portal.kernel.transaction.Transactional; 024 025 /** 026 * Provides the local service interface for UserGroupRole. Methods of this 027 * service will not have security checks based on the propagated JAAS 028 * credentials because this service can only be accessed from within the same 029 * VM. 030 * 031 * @author Brian Wing Shun Chan 032 * @see UserGroupRoleLocalServiceUtil 033 * @see com.liferay.portal.service.base.UserGroupRoleLocalServiceBaseImpl 034 * @see com.liferay.portal.service.impl.UserGroupRoleLocalServiceImpl 035 * @generated 036 */ 037 @ProviderType 038 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 039 PortalException.class, SystemException.class}) 040 public interface UserGroupRoleLocalService extends BaseLocalService, 041 PersistedModelLocalService { 042 /* 043 * NOTE FOR DEVELOPERS: 044 * 045 * Never modify or reference this interface directly. Always use {@link UserGroupRoleLocalServiceUtil} to access the user group role local service. Add custom service methods to {@link com.liferay.portal.service.impl.UserGroupRoleLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 046 */ 047 048 /** 049 * Adds the user group role to the database. Also notifies the appropriate model listeners. 050 * 051 * @param userGroupRole the user group role 052 * @return the user group role that was added 053 * @throws SystemException if a system exception occurred 054 */ 055 public com.liferay.portal.model.UserGroupRole addUserGroupRole( 056 com.liferay.portal.model.UserGroupRole userGroupRole) 057 throws com.liferay.portal.kernel.exception.SystemException; 058 059 /** 060 * Creates a new user group role with the primary key. Does not add the user group role to the database. 061 * 062 * @param userGroupRolePK the primary key for the new user group role 063 * @return the new user group role 064 */ 065 public com.liferay.portal.model.UserGroupRole createUserGroupRole( 066 com.liferay.portal.service.persistence.UserGroupRolePK userGroupRolePK); 067 068 /** 069 * Deletes the user group role with the primary key from the database. Also notifies the appropriate model listeners. 070 * 071 * @param userGroupRolePK the primary key of the user group role 072 * @return the user group role that was removed 073 * @throws PortalException if a user group role with the primary key could not be found 074 * @throws SystemException if a system exception occurred 075 */ 076 public com.liferay.portal.model.UserGroupRole deleteUserGroupRole( 077 com.liferay.portal.service.persistence.UserGroupRolePK userGroupRolePK) 078 throws com.liferay.portal.kernel.exception.PortalException, 079 com.liferay.portal.kernel.exception.SystemException; 080 081 /** 082 * Deletes the user group role from the database. Also notifies the appropriate model listeners. 083 * 084 * @param userGroupRole the user group role 085 * @return the user group role that was removed 086 * @throws SystemException if a system exception occurred 087 */ 088 public com.liferay.portal.model.UserGroupRole deleteUserGroupRole( 089 com.liferay.portal.model.UserGroupRole userGroupRole) 090 throws com.liferay.portal.kernel.exception.SystemException; 091 092 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 093 094 /** 095 * Performs a dynamic query on the database and returns the matching rows. 096 * 097 * @param dynamicQuery the dynamic query 098 * @return the matching rows 099 * @throws SystemException if a system exception occurred 100 */ 101 @SuppressWarnings("rawtypes") 102 public java.util.List dynamicQuery( 103 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 104 throws com.liferay.portal.kernel.exception.SystemException; 105 106 /** 107 * Performs a dynamic query on the database and returns a range of the matching rows. 108 * 109 * <p> 110 * 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.portal.model.impl.UserGroupRoleModelImpl}. 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. 111 * </p> 112 * 113 * @param dynamicQuery the dynamic query 114 * @param start the lower bound of the range of model instances 115 * @param end the upper bound of the range of model instances (not inclusive) 116 * @return the range of matching rows 117 * @throws SystemException if a system exception occurred 118 */ 119 @SuppressWarnings("rawtypes") 120 public java.util.List dynamicQuery( 121 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 122 int end) throws com.liferay.portal.kernel.exception.SystemException; 123 124 /** 125 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 126 * 127 * <p> 128 * 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.portal.model.impl.UserGroupRoleModelImpl}. 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. 129 * </p> 130 * 131 * @param dynamicQuery the dynamic query 132 * @param start the lower bound of the range of model instances 133 * @param end the upper bound of the range of model instances (not inclusive) 134 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 135 * @return the ordered range of matching rows 136 * @throws SystemException if a system exception occurred 137 */ 138 @SuppressWarnings("rawtypes") 139 public java.util.List dynamicQuery( 140 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 141 int end, 142 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 143 throws com.liferay.portal.kernel.exception.SystemException; 144 145 /** 146 * Returns the number of rows that match the dynamic query. 147 * 148 * @param dynamicQuery the dynamic query 149 * @return the number of rows that match the dynamic query 150 * @throws SystemException if a system exception occurred 151 */ 152 public long dynamicQueryCount( 153 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 154 throws com.liferay.portal.kernel.exception.SystemException; 155 156 /** 157 * Returns the number of rows that match the dynamic query. 158 * 159 * @param dynamicQuery the dynamic query 160 * @param projection the projection to apply to the query 161 * @return the number of rows that match the dynamic query 162 * @throws SystemException if a system exception occurred 163 */ 164 public long dynamicQueryCount( 165 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 166 com.liferay.portal.kernel.dao.orm.Projection projection) 167 throws com.liferay.portal.kernel.exception.SystemException; 168 169 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 170 public com.liferay.portal.model.UserGroupRole fetchUserGroupRole( 171 com.liferay.portal.service.persistence.UserGroupRolePK userGroupRolePK) 172 throws com.liferay.portal.kernel.exception.SystemException; 173 174 /** 175 * Returns the user group role with the primary key. 176 * 177 * @param userGroupRolePK the primary key of the user group role 178 * @return the user group role 179 * @throws PortalException if a user group role with the primary key could not be found 180 * @throws SystemException if a system exception occurred 181 */ 182 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 183 public com.liferay.portal.model.UserGroupRole getUserGroupRole( 184 com.liferay.portal.service.persistence.UserGroupRolePK userGroupRolePK) 185 throws com.liferay.portal.kernel.exception.PortalException, 186 com.liferay.portal.kernel.exception.SystemException; 187 188 @Override 189 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 190 public com.liferay.portal.model.PersistedModel getPersistedModel( 191 java.io.Serializable primaryKeyObj) 192 throws com.liferay.portal.kernel.exception.PortalException, 193 com.liferay.portal.kernel.exception.SystemException; 194 195 /** 196 * Returns a range of all the user group roles. 197 * 198 * <p> 199 * 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.portal.model.impl.UserGroupRoleModelImpl}. 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. 200 * </p> 201 * 202 * @param start the lower bound of the range of user group roles 203 * @param end the upper bound of the range of user group roles (not inclusive) 204 * @return the range of user group roles 205 * @throws SystemException if a system exception occurred 206 */ 207 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 208 public java.util.List<com.liferay.portal.model.UserGroupRole> getUserGroupRoles( 209 int start, int end) 210 throws com.liferay.portal.kernel.exception.SystemException; 211 212 /** 213 * Returns the number of user group roles. 214 * 215 * @return the number of user group roles 216 * @throws SystemException if a system exception occurred 217 */ 218 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 219 public int getUserGroupRolesCount() 220 throws com.liferay.portal.kernel.exception.SystemException; 221 222 /** 223 * Updates the user group role in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 224 * 225 * @param userGroupRole the user group role 226 * @return the user group role that was updated 227 * @throws SystemException if a system exception occurred 228 */ 229 public com.liferay.portal.model.UserGroupRole updateUserGroupRole( 230 com.liferay.portal.model.UserGroupRole userGroupRole) 231 throws com.liferay.portal.kernel.exception.SystemException; 232 233 /** 234 * Returns the Spring bean ID for this bean. 235 * 236 * @return the Spring bean ID for this bean 237 */ 238 public java.lang.String getBeanIdentifier(); 239 240 /** 241 * Sets the Spring bean ID for this bean. 242 * 243 * @param beanIdentifier the Spring bean ID for this bean 244 */ 245 public void setBeanIdentifier(java.lang.String beanIdentifier); 246 247 public java.util.List<com.liferay.portal.model.UserGroupRole> addUserGroupRoles( 248 long userId, long groupId, long[] roleIds) 249 throws com.liferay.portal.kernel.exception.SystemException; 250 251 public java.util.List<com.liferay.portal.model.UserGroupRole> addUserGroupRoles( 252 long[] userIds, long groupId, long roleId) 253 throws com.liferay.portal.kernel.exception.SystemException; 254 255 public void deleteUserGroupRoles(long userId, long groupId, long[] roleIds) 256 throws com.liferay.portal.kernel.exception.SystemException; 257 258 public void deleteUserGroupRoles(long userId, long[] groupIds) 259 throws com.liferay.portal.kernel.exception.SystemException; 260 261 public void deleteUserGroupRoles(long[] userIds, long groupId) 262 throws com.liferay.portal.kernel.exception.SystemException; 263 264 public void deleteUserGroupRoles(long[] userIds, long groupId, int roleType) 265 throws com.liferay.portal.kernel.exception.SystemException; 266 267 public void deleteUserGroupRoles(long[] userIds, long groupId, long roleId) 268 throws com.liferay.portal.kernel.exception.SystemException; 269 270 public void deleteUserGroupRolesByGroupId(long groupId) 271 throws com.liferay.portal.kernel.exception.SystemException; 272 273 public void deleteUserGroupRolesByRoleId(long roleId) 274 throws com.liferay.portal.kernel.exception.SystemException; 275 276 public void deleteUserGroupRolesByUserId(long userId) 277 throws com.liferay.portal.kernel.exception.SystemException; 278 279 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 280 public java.util.List<com.liferay.portal.model.UserGroupRole> getUserGroupRoles( 281 long userId) throws com.liferay.portal.kernel.exception.SystemException; 282 283 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 284 public java.util.List<com.liferay.portal.model.UserGroupRole> getUserGroupRoles( 285 long userId, long groupId) 286 throws com.liferay.portal.kernel.exception.SystemException; 287 288 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 289 public java.util.List<com.liferay.portal.model.UserGroupRole> getUserGroupRolesByGroup( 290 long groupId) 291 throws com.liferay.portal.kernel.exception.SystemException; 292 293 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 294 public java.util.List<com.liferay.portal.model.UserGroupRole> getUserGroupRolesByGroupAndRole( 295 long groupId, long roleId) 296 throws com.liferay.portal.kernel.exception.SystemException; 297 298 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 299 public java.util.List<com.liferay.portal.model.UserGroupRole> getUserGroupRolesByUserUserGroupAndGroup( 300 long userId, long groupId) 301 throws com.liferay.portal.kernel.exception.SystemException; 302 303 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 304 public boolean hasUserGroupRole(long userId, long groupId, long roleId) 305 throws com.liferay.portal.kernel.exception.SystemException; 306 307 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 308 public boolean hasUserGroupRole(long userId, long groupId, long roleId, 309 boolean inherit) 310 throws com.liferay.portal.kernel.exception.SystemException; 311 312 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 313 public boolean hasUserGroupRole(long userId, long groupId, 314 java.lang.String roleName) 315 throws com.liferay.portal.kernel.exception.PortalException, 316 com.liferay.portal.kernel.exception.SystemException; 317 318 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 319 public boolean hasUserGroupRole(long userId, long groupId, 320 java.lang.String roleName, boolean inherit) 321 throws com.liferay.portal.kernel.exception.PortalException, 322 com.liferay.portal.kernel.exception.SystemException; 323 }