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 user group group role 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 UserGroupGroupRoleLocalServiceUtil 032 * @see com.liferay.portal.service.base.UserGroupGroupRoleLocalServiceBaseImpl 033 * @see com.liferay.portal.service.impl.UserGroupGroupRoleLocalServiceImpl 034 * @generated 035 */ 036 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 037 PortalException.class, SystemException.class}) 038 public interface UserGroupGroupRoleLocalService 039 extends PersistedModelLocalService { 040 /* 041 * NOTE FOR DEVELOPERS: 042 * 043 * Never modify or reference this interface directly. Always use {@link UserGroupGroupRoleLocalServiceUtil} to access the user group group role local service. Add custom service methods to {@link com.liferay.portal.service.impl.UserGroupGroupRoleLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 044 */ 045 046 /** 047 * Adds the user group group role to the database. Also notifies the appropriate model listeners. 048 * 049 * @param userGroupGroupRole the user group group role 050 * @return the user group group role that was added 051 * @throws SystemException if a system exception occurred 052 */ 053 public com.liferay.portal.model.UserGroupGroupRole addUserGroupGroupRole( 054 com.liferay.portal.model.UserGroupGroupRole userGroupGroupRole) 055 throws com.liferay.portal.kernel.exception.SystemException; 056 057 /** 058 * Creates a new user group group role with the primary key. Does not add the user group group role to the database. 059 * 060 * @param userGroupGroupRolePK the primary key for the new user group group role 061 * @return the new user group group role 062 */ 063 public com.liferay.portal.model.UserGroupGroupRole createUserGroupGroupRole( 064 com.liferay.portal.service.persistence.UserGroupGroupRolePK userGroupGroupRolePK); 065 066 /** 067 * Deletes the user group group role with the primary key from the database. Also notifies the appropriate model listeners. 068 * 069 * @param userGroupGroupRolePK the primary key of the user group group role 070 * @throws PortalException if a user group group role with the primary key could not be found 071 * @throws SystemException if a system exception occurred 072 */ 073 public void deleteUserGroupGroupRole( 074 com.liferay.portal.service.persistence.UserGroupGroupRolePK userGroupGroupRolePK) 075 throws com.liferay.portal.kernel.exception.PortalException, 076 com.liferay.portal.kernel.exception.SystemException; 077 078 /** 079 * Deletes the user group group role from the database. Also notifies the appropriate model listeners. 080 * 081 * @param userGroupGroupRole the user group group role 082 * @throws SystemException if a system exception occurred 083 */ 084 public void deleteUserGroupGroupRole( 085 com.liferay.portal.model.UserGroupGroupRole userGroupGroupRole) 086 throws com.liferay.portal.kernel.exception.SystemException; 087 088 /** 089 * Performs a dynamic query on the database and returns the matching rows. 090 * 091 * @param dynamicQuery the dynamic query 092 * @return the matching rows 093 * @throws SystemException if a system exception occurred 094 */ 095 @SuppressWarnings("rawtypes") 096 public java.util.List dynamicQuery( 097 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 098 throws com.liferay.portal.kernel.exception.SystemException; 099 100 /** 101 * Performs a dynamic query on the database and returns a range of the matching rows. 102 * 103 * <p> 104 * 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. 105 * </p> 106 * 107 * @param dynamicQuery the dynamic query 108 * @param start the lower bound of the range of model instances 109 * @param end the upper bound of the range of model instances (not inclusive) 110 * @return the range of matching rows 111 * @throws SystemException if a system exception occurred 112 */ 113 @SuppressWarnings("rawtypes") 114 public java.util.List dynamicQuery( 115 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 116 int end) throws com.liferay.portal.kernel.exception.SystemException; 117 118 /** 119 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 120 * 121 * <p> 122 * 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. 123 * </p> 124 * 125 * @param dynamicQuery the dynamic query 126 * @param start the lower bound of the range of model instances 127 * @param end the upper bound of the range of model instances (not inclusive) 128 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 129 * @return the ordered range of matching rows 130 * @throws SystemException if a system exception occurred 131 */ 132 @SuppressWarnings("rawtypes") 133 public java.util.List dynamicQuery( 134 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 135 int end, 136 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 137 throws com.liferay.portal.kernel.exception.SystemException; 138 139 /** 140 * Returns the number of rows that match the dynamic query. 141 * 142 * @param dynamicQuery the dynamic query 143 * @return the number of rows that match the dynamic query 144 * @throws SystemException if a system exception occurred 145 */ 146 public long dynamicQueryCount( 147 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 148 throws com.liferay.portal.kernel.exception.SystemException; 149 150 /** 151 * Returns the user group group role with the primary key. 152 * 153 * @param userGroupGroupRolePK the primary key of the user group group role 154 * @return the user group group role 155 * @throws PortalException if a user group group role with the primary key could not be found 156 * @throws SystemException if a system exception occurred 157 */ 158 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 159 public com.liferay.portal.model.UserGroupGroupRole getUserGroupGroupRole( 160 com.liferay.portal.service.persistence.UserGroupGroupRolePK userGroupGroupRolePK) 161 throws com.liferay.portal.kernel.exception.PortalException, 162 com.liferay.portal.kernel.exception.SystemException; 163 164 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 165 public com.liferay.portal.model.PersistedModel getPersistedModel( 166 java.io.Serializable primaryKeyObj) 167 throws com.liferay.portal.kernel.exception.PortalException, 168 com.liferay.portal.kernel.exception.SystemException; 169 170 /** 171 * Returns a range of all the user group group roles. 172 * 173 * <p> 174 * 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. 175 * </p> 176 * 177 * @param start the lower bound of the range of user group group roles 178 * @param end the upper bound of the range of user group group roles (not inclusive) 179 * @return the range of user group group roles 180 * @throws SystemException if a system exception occurred 181 */ 182 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 183 public java.util.List<com.liferay.portal.model.UserGroupGroupRole> getUserGroupGroupRoles( 184 int start, int end) 185 throws com.liferay.portal.kernel.exception.SystemException; 186 187 /** 188 * Returns the number of user group group roles. 189 * 190 * @return the number of user group group roles 191 * @throws SystemException if a system exception occurred 192 */ 193 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 194 public int getUserGroupGroupRolesCount() 195 throws com.liferay.portal.kernel.exception.SystemException; 196 197 /** 198 * Updates the user group group role in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 199 * 200 * @param userGroupGroupRole the user group group role 201 * @return the user group group role that was updated 202 * @throws SystemException if a system exception occurred 203 */ 204 public com.liferay.portal.model.UserGroupGroupRole updateUserGroupGroupRole( 205 com.liferay.portal.model.UserGroupGroupRole userGroupGroupRole) 206 throws com.liferay.portal.kernel.exception.SystemException; 207 208 /** 209 * Updates the user group group role in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 210 * 211 * @param userGroupGroupRole the user group group role 212 * @param merge whether to merge the user group group role 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. 213 * @return the user group group role that was updated 214 * @throws SystemException if a system exception occurred 215 */ 216 public com.liferay.portal.model.UserGroupGroupRole updateUserGroupGroupRole( 217 com.liferay.portal.model.UserGroupGroupRole userGroupGroupRole, 218 boolean merge) 219 throws com.liferay.portal.kernel.exception.SystemException; 220 221 /** 222 * Returns the Spring bean ID for this bean. 223 * 224 * @return the Spring bean ID for this bean 225 */ 226 public java.lang.String getBeanIdentifier(); 227 228 /** 229 * Sets the Spring bean ID for this bean. 230 * 231 * @param beanIdentifier the Spring bean ID for this bean 232 */ 233 public void setBeanIdentifier(java.lang.String beanIdentifier); 234 235 public void addUserGroupGroupRoles(long userGroupId, long groupId, 236 long[] roleIds) 237 throws com.liferay.portal.kernel.exception.PortalException, 238 com.liferay.portal.kernel.exception.SystemException; 239 240 public void addUserGroupGroupRoles(long[] userGroupIds, long groupId, 241 long roleId) 242 throws com.liferay.portal.kernel.exception.PortalException, 243 com.liferay.portal.kernel.exception.SystemException; 244 245 public void deleteUserGroupGroupRoles(long userGroupId, long groupId, 246 long[] roleIds) 247 throws com.liferay.portal.kernel.exception.SystemException; 248 249 public void deleteUserGroupGroupRoles(long userGroupId, long[] groupIds) 250 throws com.liferay.portal.kernel.exception.SystemException; 251 252 public void deleteUserGroupGroupRoles(long[] userGroupIds, long groupId) 253 throws com.liferay.portal.kernel.exception.SystemException; 254 255 public void deleteUserGroupGroupRoles(long[] userGroupIds, long groupId, 256 long roleId) throws com.liferay.portal.kernel.exception.SystemException; 257 258 public void deleteUserGroupGroupRolesByGroupId(long groupId) 259 throws com.liferay.portal.kernel.exception.SystemException; 260 261 public void deleteUserGroupGroupRolesByRoleId(long roleId) 262 throws com.liferay.portal.kernel.exception.SystemException; 263 264 public void deleteUserGroupGroupRolesByUserGroupId(long userGroupId) 265 throws com.liferay.portal.kernel.exception.SystemException; 266 267 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 268 public java.util.List<com.liferay.portal.model.UserGroupGroupRole> getUserGroupGroupRoles( 269 long userGroupId) 270 throws com.liferay.portal.kernel.exception.SystemException; 271 272 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 273 public java.util.List<com.liferay.portal.model.UserGroupGroupRole> getUserGroupGroupRoles( 274 long userGroupId, long groupId) 275 throws com.liferay.portal.kernel.exception.SystemException; 276 277 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 278 public java.util.List<com.liferay.portal.model.UserGroupGroupRole> getUserGroupGroupRolesByGroupAndRole( 279 long groupId, long roleId) 280 throws com.liferay.portal.kernel.exception.SystemException; 281 282 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 283 public boolean hasUserGroupGroupRole(long userGroupId, long groupId, 284 long roleId) throws com.liferay.portal.kernel.exception.SystemException; 285 286 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 287 public boolean hasUserGroupGroupRole(long userGroupId, long groupId, 288 java.lang.String roleName) 289 throws com.liferay.portal.kernel.exception.PortalException, 290 com.liferay.portal.kernel.exception.SystemException; 291 }