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 UserGroupGroupRole. 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 UserGroupGroupRoleLocalServiceUtil 033 * @see com.liferay.portal.service.base.UserGroupGroupRoleLocalServiceBaseImpl 034 * @see com.liferay.portal.service.impl.UserGroupGroupRoleLocalServiceImpl 035 * @generated 036 */ 037 @ProviderType 038 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 039 PortalException.class, SystemException.class}) 040 public interface UserGroupGroupRoleLocalService extends BaseLocalService, 041 PersistedModelLocalService { 042 /* 043 * NOTE FOR DEVELOPERS: 044 * 045 * 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. 046 */ 047 048 /** 049 * Adds the user group group role to the database. Also notifies the appropriate model listeners. 050 * 051 * @param userGroupGroupRole the user group group role 052 * @return the user group group role that was added 053 * @throws SystemException if a system exception occurred 054 */ 055 public com.liferay.portal.model.UserGroupGroupRole addUserGroupGroupRole( 056 com.liferay.portal.model.UserGroupGroupRole userGroupGroupRole) 057 throws com.liferay.portal.kernel.exception.SystemException; 058 059 /** 060 * Creates a new user group group role with the primary key. Does not add the user group group role to the database. 061 * 062 * @param userGroupGroupRolePK the primary key for the new user group group role 063 * @return the new user group group role 064 */ 065 public com.liferay.portal.model.UserGroupGroupRole createUserGroupGroupRole( 066 com.liferay.portal.service.persistence.UserGroupGroupRolePK userGroupGroupRolePK); 067 068 /** 069 * Deletes the user group group role with the primary key from the database. Also notifies the appropriate model listeners. 070 * 071 * @param userGroupGroupRolePK the primary key of the user group group role 072 * @return the user group group role that was removed 073 * @throws PortalException if a user group 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.UserGroupGroupRole deleteUserGroupGroupRole( 077 com.liferay.portal.service.persistence.UserGroupGroupRolePK userGroupGroupRolePK) 078 throws com.liferay.portal.kernel.exception.PortalException, 079 com.liferay.portal.kernel.exception.SystemException; 080 081 /** 082 * Deletes the user group group role from the database. Also notifies the appropriate model listeners. 083 * 084 * @param userGroupGroupRole the user group group role 085 * @return the user group group role that was removed 086 * @throws SystemException if a system exception occurred 087 */ 088 public com.liferay.portal.model.UserGroupGroupRole deleteUserGroupGroupRole( 089 com.liferay.portal.model.UserGroupGroupRole userGroupGroupRole) 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.UserGroupGroupRoleModelImpl}. 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.UserGroupGroupRoleModelImpl}. 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.UserGroupGroupRole fetchUserGroupGroupRole( 171 com.liferay.portal.service.persistence.UserGroupGroupRolePK userGroupGroupRolePK) 172 throws com.liferay.portal.kernel.exception.SystemException; 173 174 /** 175 * Returns the user group group role with the primary key. 176 * 177 * @param userGroupGroupRolePK the primary key of the user group group role 178 * @return the user group group role 179 * @throws PortalException if a user group 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.UserGroupGroupRole getUserGroupGroupRole( 184 com.liferay.portal.service.persistence.UserGroupGroupRolePK userGroupGroupRolePK) 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 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.UserGroupGroupRoleModelImpl}. 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 group roles 203 * @param end the upper bound of the range of user group group roles (not inclusive) 204 * @return the range of user group 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.UserGroupGroupRole> getUserGroupGroupRoles( 209 int start, int end) 210 throws com.liferay.portal.kernel.exception.SystemException; 211 212 /** 213 * Returns the number of user group group roles. 214 * 215 * @return the number of user group group roles 216 * @throws SystemException if a system exception occurred 217 */ 218 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 219 public int getUserGroupGroupRolesCount() 220 throws com.liferay.portal.kernel.exception.SystemException; 221 222 /** 223 * Updates the user group group role in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 224 * 225 * @param userGroupGroupRole the user group group role 226 * @return the user group group role that was updated 227 * @throws SystemException if a system exception occurred 228 */ 229 public com.liferay.portal.model.UserGroupGroupRole updateUserGroupGroupRole( 230 com.liferay.portal.model.UserGroupGroupRole userGroupGroupRole) 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 void addUserGroupGroupRoles(long userGroupId, long groupId, 248 long[] roleIds) 249 throws com.liferay.portal.kernel.exception.SystemException; 250 251 public void addUserGroupGroupRoles(long[] userGroupIds, long groupId, 252 long roleId) throws com.liferay.portal.kernel.exception.SystemException; 253 254 public void deleteUserGroupGroupRoles(long userGroupId, long groupId, 255 long[] roleIds) 256 throws com.liferay.portal.kernel.exception.SystemException; 257 258 public void deleteUserGroupGroupRoles(long userGroupId, long[] groupIds) 259 throws com.liferay.portal.kernel.exception.SystemException; 260 261 public void deleteUserGroupGroupRoles(long[] userGroupIds, long groupId) 262 throws com.liferay.portal.kernel.exception.SystemException; 263 264 public void deleteUserGroupGroupRoles(long[] userGroupIds, long groupId, 265 long roleId) throws com.liferay.portal.kernel.exception.SystemException; 266 267 public void deleteUserGroupGroupRolesByGroupId(long groupId) 268 throws com.liferay.portal.kernel.exception.SystemException; 269 270 public void deleteUserGroupGroupRolesByRoleId(long roleId) 271 throws com.liferay.portal.kernel.exception.SystemException; 272 273 public void deleteUserGroupGroupRolesByUserGroupId(long userGroupId) 274 throws com.liferay.portal.kernel.exception.SystemException; 275 276 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 277 public java.util.List<com.liferay.portal.model.UserGroupGroupRole> getUserGroupGroupRoles( 278 long userGroupId) 279 throws com.liferay.portal.kernel.exception.SystemException; 280 281 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 282 public java.util.List<com.liferay.portal.model.UserGroupGroupRole> getUserGroupGroupRoles( 283 long userGroupId, long groupId) 284 throws com.liferay.portal.kernel.exception.SystemException; 285 286 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 287 public java.util.List<com.liferay.portal.model.UserGroupGroupRole> getUserGroupGroupRolesByGroupAndRole( 288 long groupId, long roleId) 289 throws com.liferay.portal.kernel.exception.SystemException; 290 291 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 292 public boolean hasUserGroupGroupRole(long userGroupId, long groupId, 293 long roleId) throws com.liferay.portal.kernel.exception.SystemException; 294 295 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 296 public boolean hasUserGroupGroupRole(long userGroupId, long groupId, 297 java.lang.String roleName) 298 throws com.liferay.portal.kernel.exception.PortalException, 299 com.liferay.portal.kernel.exception.SystemException; 300 }