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 com.liferay.portal.kernel.bean.PortalBeanLocatorUtil; 018 import com.liferay.portal.kernel.util.ReferenceRegistry; 019 020 /** 021 * The utility for the user group group role local service. This utility wraps {@link com.liferay.portal.service.impl.UserGroupGroupRoleLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server. 022 * 023 * <p> 024 * 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. 025 * </p> 026 * 027 * @author Brian Wing Shun Chan 028 * @see UserGroupGroupRoleLocalService 029 * @see com.liferay.portal.service.base.UserGroupGroupRoleLocalServiceBaseImpl 030 * @see com.liferay.portal.service.impl.UserGroupGroupRoleLocalServiceImpl 031 * @generated 032 */ 033 public class UserGroupGroupRoleLocalServiceUtil { 034 /* 035 * NOTE FOR DEVELOPERS: 036 * 037 * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.UserGroupGroupRoleLocalServiceImpl} and rerun ServiceBuilder to regenerate this class. 038 */ 039 040 /** 041 * Adds the user group group role to the database. Also notifies the appropriate model listeners. 042 * 043 * @param userGroupGroupRole the user group group role 044 * @return the user group group role that was added 045 * @throws SystemException if a system exception occurred 046 */ 047 public static com.liferay.portal.model.UserGroupGroupRole addUserGroupGroupRole( 048 com.liferay.portal.model.UserGroupGroupRole userGroupGroupRole) 049 throws com.liferay.portal.kernel.exception.SystemException { 050 return getService().addUserGroupGroupRole(userGroupGroupRole); 051 } 052 053 /** 054 * Creates a new user group group role with the primary key. Does not add the user group group role to the database. 055 * 056 * @param userGroupGroupRolePK the primary key for the new user group group role 057 * @return the new user group group role 058 */ 059 public static com.liferay.portal.model.UserGroupGroupRole createUserGroupGroupRole( 060 com.liferay.portal.service.persistence.UserGroupGroupRolePK userGroupGroupRolePK) { 061 return getService().createUserGroupGroupRole(userGroupGroupRolePK); 062 } 063 064 /** 065 * Deletes the user group group role with the primary key from the database. Also notifies the appropriate model listeners. 066 * 067 * @param userGroupGroupRolePK the primary key of the user group group role 068 * @return the user group group role that was removed 069 * @throws PortalException if a user group group role with the primary key could not be found 070 * @throws SystemException if a system exception occurred 071 */ 072 public static com.liferay.portal.model.UserGroupGroupRole deleteUserGroupGroupRole( 073 com.liferay.portal.service.persistence.UserGroupGroupRolePK userGroupGroupRolePK) 074 throws com.liferay.portal.kernel.exception.PortalException, 075 com.liferay.portal.kernel.exception.SystemException { 076 return getService().deleteUserGroupGroupRole(userGroupGroupRolePK); 077 } 078 079 /** 080 * Deletes the user group group role from the database. Also notifies the appropriate model listeners. 081 * 082 * @param userGroupGroupRole the user group group role 083 * @return the user group group role that was removed 084 * @throws SystemException if a system exception occurred 085 */ 086 public static com.liferay.portal.model.UserGroupGroupRole deleteUserGroupGroupRole( 087 com.liferay.portal.model.UserGroupGroupRole userGroupGroupRole) 088 throws com.liferay.portal.kernel.exception.SystemException { 089 return getService().deleteUserGroupGroupRole(userGroupGroupRole); 090 } 091 092 public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() { 093 return getService().dynamicQuery(); 094 } 095 096 /** 097 * Performs a dynamic query on the database and returns the matching rows. 098 * 099 * @param dynamicQuery the dynamic query 100 * @return the matching rows 101 * @throws SystemException if a system exception occurred 102 */ 103 @SuppressWarnings("rawtypes") 104 public static java.util.List dynamicQuery( 105 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 106 throws com.liferay.portal.kernel.exception.SystemException { 107 return getService().dynamicQuery(dynamicQuery); 108 } 109 110 /** 111 * Performs a dynamic query on the database and returns a range of the matching rows. 112 * 113 * <p> 114 * 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. 115 * </p> 116 * 117 * @param dynamicQuery the dynamic query 118 * @param start the lower bound of the range of model instances 119 * @param end the upper bound of the range of model instances (not inclusive) 120 * @return the range of matching rows 121 * @throws SystemException if a system exception occurred 122 */ 123 @SuppressWarnings("rawtypes") 124 public static java.util.List dynamicQuery( 125 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 126 int end) throws com.liferay.portal.kernel.exception.SystemException { 127 return getService().dynamicQuery(dynamicQuery, start, end); 128 } 129 130 /** 131 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 132 * 133 * <p> 134 * 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. 135 * </p> 136 * 137 * @param dynamicQuery the dynamic query 138 * @param start the lower bound of the range of model instances 139 * @param end the upper bound of the range of model instances (not inclusive) 140 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 141 * @return the ordered range of matching rows 142 * @throws SystemException if a system exception occurred 143 */ 144 @SuppressWarnings("rawtypes") 145 public static java.util.List dynamicQuery( 146 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 147 int end, 148 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 149 throws com.liferay.portal.kernel.exception.SystemException { 150 return getService() 151 .dynamicQuery(dynamicQuery, start, end, orderByComparator); 152 } 153 154 /** 155 * Returns the number of rows that match the dynamic query. 156 * 157 * @param dynamicQuery the dynamic query 158 * @return the number of rows that match the dynamic query 159 * @throws SystemException if a system exception occurred 160 */ 161 public static long dynamicQueryCount( 162 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 163 throws com.liferay.portal.kernel.exception.SystemException { 164 return getService().dynamicQueryCount(dynamicQuery); 165 } 166 167 public static com.liferay.portal.model.UserGroupGroupRole fetchUserGroupGroupRole( 168 com.liferay.portal.service.persistence.UserGroupGroupRolePK userGroupGroupRolePK) 169 throws com.liferay.portal.kernel.exception.SystemException { 170 return getService().fetchUserGroupGroupRole(userGroupGroupRolePK); 171 } 172 173 /** 174 * Returns the user group group role with the primary key. 175 * 176 * @param userGroupGroupRolePK the primary key of the user group group role 177 * @return the user group group role 178 * @throws PortalException if a user group group role with the primary key could not be found 179 * @throws SystemException if a system exception occurred 180 */ 181 public static com.liferay.portal.model.UserGroupGroupRole getUserGroupGroupRole( 182 com.liferay.portal.service.persistence.UserGroupGroupRolePK userGroupGroupRolePK) 183 throws com.liferay.portal.kernel.exception.PortalException, 184 com.liferay.portal.kernel.exception.SystemException { 185 return getService().getUserGroupGroupRole(userGroupGroupRolePK); 186 } 187 188 public static com.liferay.portal.model.PersistedModel getPersistedModel( 189 java.io.Serializable primaryKeyObj) 190 throws com.liferay.portal.kernel.exception.PortalException, 191 com.liferay.portal.kernel.exception.SystemException { 192 return getService().getPersistedModel(primaryKeyObj); 193 } 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 public static java.util.List<com.liferay.portal.model.UserGroupGroupRole> getUserGroupGroupRoles( 208 int start, int end) 209 throws com.liferay.portal.kernel.exception.SystemException { 210 return getService().getUserGroupGroupRoles(start, end); 211 } 212 213 /** 214 * Returns the number of user group group roles. 215 * 216 * @return the number of user group group roles 217 * @throws SystemException if a system exception occurred 218 */ 219 public static int getUserGroupGroupRolesCount() 220 throws com.liferay.portal.kernel.exception.SystemException { 221 return getService().getUserGroupGroupRolesCount(); 222 } 223 224 /** 225 * Updates the user group group role in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 226 * 227 * @param userGroupGroupRole the user group group role 228 * @return the user group group role that was updated 229 * @throws SystemException if a system exception occurred 230 */ 231 public static com.liferay.portal.model.UserGroupGroupRole updateUserGroupGroupRole( 232 com.liferay.portal.model.UserGroupGroupRole userGroupGroupRole) 233 throws com.liferay.portal.kernel.exception.SystemException { 234 return getService().updateUserGroupGroupRole(userGroupGroupRole); 235 } 236 237 /** 238 * Returns the Spring bean ID for this bean. 239 * 240 * @return the Spring bean ID for this bean 241 */ 242 public static java.lang.String getBeanIdentifier() { 243 return getService().getBeanIdentifier(); 244 } 245 246 /** 247 * Sets the Spring bean ID for this bean. 248 * 249 * @param beanIdentifier the Spring bean ID for this bean 250 */ 251 public static void setBeanIdentifier(java.lang.String beanIdentifier) { 252 getService().setBeanIdentifier(beanIdentifier); 253 } 254 255 public static void addUserGroupGroupRoles(long userGroupId, long groupId, 256 long[] roleIds) 257 throws com.liferay.portal.kernel.exception.SystemException { 258 getService().addUserGroupGroupRoles(userGroupId, groupId, roleIds); 259 } 260 261 public static void addUserGroupGroupRoles(long[] userGroupIds, 262 long groupId, long roleId) 263 throws com.liferay.portal.kernel.exception.SystemException { 264 getService().addUserGroupGroupRoles(userGroupIds, groupId, roleId); 265 } 266 267 public static void deleteUserGroupGroupRoles(long userGroupId, 268 long groupId, long[] roleIds) 269 throws com.liferay.portal.kernel.exception.SystemException { 270 getService().deleteUserGroupGroupRoles(userGroupId, groupId, roleIds); 271 } 272 273 public static void deleteUserGroupGroupRoles(long userGroupId, 274 long[] groupIds) 275 throws com.liferay.portal.kernel.exception.SystemException { 276 getService().deleteUserGroupGroupRoles(userGroupId, groupIds); 277 } 278 279 public static void deleteUserGroupGroupRoles(long[] userGroupIds, 280 long groupId) 281 throws com.liferay.portal.kernel.exception.SystemException { 282 getService().deleteUserGroupGroupRoles(userGroupIds, groupId); 283 } 284 285 public static void deleteUserGroupGroupRoles(long[] userGroupIds, 286 long groupId, long roleId) 287 throws com.liferay.portal.kernel.exception.SystemException { 288 getService().deleteUserGroupGroupRoles(userGroupIds, groupId, roleId); 289 } 290 291 public static void deleteUserGroupGroupRolesByGroupId(long groupId) 292 throws com.liferay.portal.kernel.exception.SystemException { 293 getService().deleteUserGroupGroupRolesByGroupId(groupId); 294 } 295 296 public static void deleteUserGroupGroupRolesByRoleId(long roleId) 297 throws com.liferay.portal.kernel.exception.SystemException { 298 getService().deleteUserGroupGroupRolesByRoleId(roleId); 299 } 300 301 public static void deleteUserGroupGroupRolesByUserGroupId(long userGroupId) 302 throws com.liferay.portal.kernel.exception.SystemException { 303 getService().deleteUserGroupGroupRolesByUserGroupId(userGroupId); 304 } 305 306 public static java.util.List<com.liferay.portal.model.UserGroupGroupRole> getUserGroupGroupRoles( 307 long userGroupId) 308 throws com.liferay.portal.kernel.exception.SystemException { 309 return getService().getUserGroupGroupRoles(userGroupId); 310 } 311 312 public static java.util.List<com.liferay.portal.model.UserGroupGroupRole> getUserGroupGroupRoles( 313 long userGroupId, long groupId) 314 throws com.liferay.portal.kernel.exception.SystemException { 315 return getService().getUserGroupGroupRoles(userGroupId, groupId); 316 } 317 318 public static java.util.List<com.liferay.portal.model.UserGroupGroupRole> getUserGroupGroupRolesByGroupAndRole( 319 long groupId, long roleId) 320 throws com.liferay.portal.kernel.exception.SystemException { 321 return getService().getUserGroupGroupRolesByGroupAndRole(groupId, roleId); 322 } 323 324 public static boolean hasUserGroupGroupRole(long userGroupId, long groupId, 325 long roleId) throws com.liferay.portal.kernel.exception.SystemException { 326 return getService().hasUserGroupGroupRole(userGroupId, groupId, roleId); 327 } 328 329 public static boolean hasUserGroupGroupRole(long userGroupId, long groupId, 330 java.lang.String roleName) 331 throws com.liferay.portal.kernel.exception.PortalException, 332 com.liferay.portal.kernel.exception.SystemException { 333 return getService().hasUserGroupGroupRole(userGroupId, groupId, roleName); 334 } 335 336 public static UserGroupGroupRoleLocalService getService() { 337 if (_service == null) { 338 _service = (UserGroupGroupRoleLocalService)PortalBeanLocatorUtil.locate(UserGroupGroupRoleLocalService.class.getName()); 339 340 ReferenceRegistry.registerReference(UserGroupGroupRoleLocalServiceUtil.class, 341 "_service"); 342 } 343 344 return _service; 345 } 346 347 /** 348 * @deprecated As of 6.2.0 349 */ 350 public void setService(UserGroupGroupRoleLocalService service) { 351 } 352 353 private static UserGroupGroupRoleLocalService _service; 354 }