001 /** 002 * Copyright (c) 2000-present 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 /** 020 * Provides a wrapper for {@link UserGroupService}. 021 * 022 * @author Brian Wing Shun Chan 023 * @see UserGroupService 024 * @generated 025 */ 026 @ProviderType 027 public class UserGroupServiceWrapper implements UserGroupService, 028 ServiceWrapper<UserGroupService> { 029 public UserGroupServiceWrapper(UserGroupService userGroupService) { 030 _userGroupService = userGroupService; 031 } 032 033 /** 034 * Adds the user groups to the group. 035 * 036 * @param groupId the primary key of the group 037 * @param userGroupIds the primary keys of the user groups 038 * @throws PortalException if a group or user group with the primary key 039 could not be found, or if the user did not have permission to 040 assign group members 041 */ 042 @Override 043 public void addGroupUserGroups(long groupId, long[] userGroupIds) 044 throws com.liferay.portal.kernel.exception.PortalException { 045 _userGroupService.addGroupUserGroups(groupId, userGroupIds); 046 } 047 048 /** 049 * Adds the user groups to the team 050 * 051 * @param teamId the primary key of the team 052 * @param userGroupIds the primary keys of the user groups 053 * @throws PortalException if a team or user group with the primary key 054 could not be found, or if the user did not have permission to 055 assign team members 056 */ 057 @Override 058 public void addTeamUserGroups(long teamId, long[] userGroupIds) 059 throws com.liferay.portal.kernel.exception.PortalException { 060 _userGroupService.addTeamUserGroups(teamId, userGroupIds); 061 } 062 063 /** 064 * Adds a user group. 065 * 066 * <p> 067 * This method handles the creation and bookkeeping of the user group, 068 * including its resources, metadata, and internal data structures. 069 * </p> 070 * 071 * @param name the user group's name 072 * @param description the user group's description 073 * @return the user group 074 * @throws PortalException if the user group's information was invalid 075 or if the user did not have permission to add the user group 076 * @deprecated As of 6.2.0, replaced by {@link #addUserGroup(String, String, 077 ServiceContext)} 078 */ 079 @Deprecated 080 @Override 081 public com.liferay.portal.model.UserGroup addUserGroup( 082 java.lang.String name, java.lang.String description) 083 throws com.liferay.portal.kernel.exception.PortalException { 084 return _userGroupService.addUserGroup(name, description); 085 } 086 087 /** 088 * Adds a user group. 089 * 090 * <p> 091 * This method handles the creation and bookkeeping of the user group, 092 * including its resources, metadata, and internal data structures. 093 * </p> 094 * 095 * @param name the user group's name 096 * @param description the user group's description 097 * @param serviceContext the service context to be applied (optionally 098 <code>null</code>). Can set expando bridge attributes for the 099 user group. 100 * @return the user group 101 * @throws PortalException if the user group's information was invalid or if 102 the user did not have permission to add the user group 103 */ 104 @Override 105 public com.liferay.portal.model.UserGroup addUserGroup( 106 java.lang.String name, java.lang.String description, 107 com.liferay.portal.service.ServiceContext serviceContext) 108 throws com.liferay.portal.kernel.exception.PortalException { 109 return _userGroupService.addUserGroup(name, description, serviceContext); 110 } 111 112 /** 113 * Deletes the user group. 114 * 115 * @param userGroupId the primary key of the user group 116 * @throws PortalException if a user group with the primary key could not be 117 found, if the user did not have permission to delete the user 118 group, or if the user group had a workflow in approved status 119 */ 120 @Override 121 public void deleteUserGroup(long userGroupId) 122 throws com.liferay.portal.kernel.exception.PortalException { 123 _userGroupService.deleteUserGroup(userGroupId); 124 } 125 126 /** 127 * Returns the Spring bean ID for this bean. 128 * 129 * @return the Spring bean ID for this bean 130 */ 131 @Override 132 public java.lang.String getBeanIdentifier() { 133 return _userGroupService.getBeanIdentifier(); 134 } 135 136 /** 137 * Returns the user group with the name. 138 * 139 * @param name the user group's name 140 * @return Returns the user group with the name 141 * @throws PortalException if a user group with the name could not be found 142 or if the user did not have permission to view the user group 143 */ 144 @Override 145 public com.liferay.portal.model.UserGroup getUserGroup( 146 java.lang.String name) 147 throws com.liferay.portal.kernel.exception.PortalException { 148 return _userGroupService.getUserGroup(name); 149 } 150 151 /** 152 * Returns the user group with the primary key. 153 * 154 * @param userGroupId the primary key of the user group 155 * @return Returns the user group with the primary key 156 * @throws PortalException if a user group with the primary key could not be 157 found or if the user did not have permission to view the user 158 group 159 */ 160 @Override 161 public com.liferay.portal.model.UserGroup getUserGroup(long userGroupId) 162 throws com.liferay.portal.kernel.exception.PortalException { 163 return _userGroupService.getUserGroup(userGroupId); 164 } 165 166 /** 167 * Returns all the user groups to which the user belongs. 168 * 169 * @param userId the primary key of the user 170 * @return the user groups to which the user belongs 171 * @throws PortalException if the current user did not have permission to 172 view the user or any one of the user group members 173 */ 174 @Override 175 public java.util.List<com.liferay.portal.model.UserGroup> getUserUserGroups( 176 long userId) throws com.liferay.portal.kernel.exception.PortalException { 177 return _userGroupService.getUserUserGroups(userId); 178 } 179 180 /** 181 * Sets the Spring bean ID for this bean. 182 * 183 * @param beanIdentifier the Spring bean ID for this bean 184 */ 185 @Override 186 public void setBeanIdentifier(java.lang.String beanIdentifier) { 187 _userGroupService.setBeanIdentifier(beanIdentifier); 188 } 189 190 /** 191 * Removes the user groups from the group. 192 * 193 * @param groupId the primary key of the group 194 * @param userGroupIds the primary keys of the user groups 195 * @throws PortalException if the user did not have permission to assign 196 group members 197 */ 198 @Override 199 public void unsetGroupUserGroups(long groupId, long[] userGroupIds) 200 throws com.liferay.portal.kernel.exception.PortalException { 201 _userGroupService.unsetGroupUserGroups(groupId, userGroupIds); 202 } 203 204 /** 205 * Removes the user groups from the team. 206 * 207 * @param teamId the primary key of the team 208 * @param userGroupIds the primary keys of the user groups 209 * @throws PortalException if the user did not have permission to assign 210 team members 211 */ 212 @Override 213 public void unsetTeamUserGroups(long teamId, long[] userGroupIds) 214 throws com.liferay.portal.kernel.exception.PortalException { 215 _userGroupService.unsetTeamUserGroups(teamId, userGroupIds); 216 } 217 218 /** 219 * Updates the user group. 220 * 221 * @param userGroupId the primary key of the user group 222 * @param name the user group's name 223 * @param description the the user group's description 224 * @return the user group 225 * @throws PortalException if a user group with the primary key was not 226 found, if the new information was invalid, or if the user did 227 not have permission to update the user group information 228 * @deprecated As of 6.2.0, replaced by {@link #updateUserGroup(long, 229 String, String, ServiceContext)} 230 */ 231 @Deprecated 232 @Override 233 public com.liferay.portal.model.UserGroup updateUserGroup( 234 long userGroupId, java.lang.String name, java.lang.String description) 235 throws com.liferay.portal.kernel.exception.PortalException { 236 return _userGroupService.updateUserGroup(userGroupId, name, description); 237 } 238 239 /** 240 * Updates the user group. 241 * 242 * @param userGroupId the primary key of the user group 243 * @param name the user group's name 244 * @param description the the user group's description 245 * @param serviceContext the service context to be applied (optionally 246 <code>null</code>). Can set expando bridge attributes for the 247 user group. 248 * @return the user group 249 * @throws PortalException if a user group with the primary key was not 250 found, if the new information was invalid, or if the user did not 251 have permission to update the user group information 252 */ 253 @Override 254 public com.liferay.portal.model.UserGroup updateUserGroup( 255 long userGroupId, java.lang.String name, java.lang.String description, 256 com.liferay.portal.service.ServiceContext serviceContext) 257 throws com.liferay.portal.kernel.exception.PortalException { 258 return _userGroupService.updateUserGroup(userGroupId, name, 259 description, serviceContext); 260 } 261 262 /** 263 * @deprecated As of 6.1.0, replaced by {@link #getWrappedService} 264 */ 265 @Deprecated 266 public UserGroupService getWrappedUserGroupService() { 267 return _userGroupService; 268 } 269 270 /** 271 * @deprecated As of 6.1.0, replaced by {@link #setWrappedService} 272 */ 273 @Deprecated 274 public void setWrappedUserGroupService(UserGroupService userGroupService) { 275 _userGroupService = userGroupService; 276 } 277 278 @Override 279 public UserGroupService getWrappedService() { 280 return _userGroupService; 281 } 282 283 @Override 284 public void setWrappedService(UserGroupService userGroupService) { 285 _userGroupService = userGroupService; 286 } 287 288 private UserGroupService _userGroupService; 289 }