001 /** 002 * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved. 003 * 004 * The contents of this file are subject to the terms of the Liferay Enterprise 005 * Subscription License ("License"). You may not use this file except in 006 * compliance with the License. You can obtain a copy of the License by 007 * contacting Liferay, Inc. See the License for the specific language governing 008 * permissions and limitations under the License, including but not limited to 009 * distribution rights of the Software. 010 * 011 * 012 * 013 */ 014 015 package com.liferay.portal.service; 016 017 /** 018 * <p> 019 * This class is a wrapper for {@link UserGroupService}. 020 * </p> 021 * 022 * @author Brian Wing Shun Chan 023 * @see UserGroupService 024 * @generated 025 */ 026 public class UserGroupServiceWrapper implements UserGroupService, 027 ServiceWrapper<UserGroupService> { 028 public UserGroupServiceWrapper(UserGroupService userGroupService) { 029 _userGroupService = userGroupService; 030 } 031 032 /** 033 * Adds the user groups to the group. 034 * 035 * @param groupId the primary key of the group 036 * @param userGroupIds the primary keys of the user groups 037 * @throws PortalException if a group or user group with the primary key 038 could not be found, or if the user did not have permission to 039 assign group members 040 * @throws SystemException if a system exception occurred 041 */ 042 public void addGroupUserGroups(long groupId, long[] userGroupIds) 043 throws com.liferay.portal.kernel.exception.PortalException, 044 com.liferay.portal.kernel.exception.SystemException { 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 * @throws SystemException if a system exception occurred 057 */ 058 public void addTeamUserGroups(long teamId, long[] userGroupIds) 059 throws com.liferay.portal.kernel.exception.PortalException, 060 com.liferay.portal.kernel.exception.SystemException { 061 _userGroupService.addTeamUserGroups(teamId, userGroupIds); 062 } 063 064 /** 065 * Adds a user group. 066 * 067 * <p> 068 * This method handles the creation and bookkeeping of the user group, 069 * including its resources, metadata, and internal data structures. 070 * </p> 071 * 072 * @param name the user group's name 073 * @param description the user group's description 074 * @param publicLayoutSetPrototypeId the primary key of the user group's 075 public layout set 076 * @param privateLayoutSetPrototypeId the primary key of the user group's 077 private layout set 078 * @return the user group 079 * @throws PortalException if the user group's information was invalid or 080 if the user did not have permission to add the user group 081 * @throws SystemException if a system exception occurred 082 */ 083 public com.liferay.portal.model.UserGroup addUserGroup( 084 java.lang.String name, java.lang.String description, 085 long publicLayoutSetPrototypeId, long privateLayoutSetPrototypeId) 086 throws com.liferay.portal.kernel.exception.PortalException, 087 com.liferay.portal.kernel.exception.SystemException { 088 return _userGroupService.addUserGroup(name, description, 089 publicLayoutSetPrototypeId, privateLayoutSetPrototypeId); 090 } 091 092 /** 093 * Deletes the user group. 094 * 095 * @param userGroupId the primary key of the user group 096 * @throws PortalException if a user group with the primary key could not 097 be found, if the user did not have permission to delete the user 098 group, or if the user group had a workflow in approved status 099 * @throws SystemException if a system exception occurred 100 */ 101 public void deleteUserGroup(long userGroupId) 102 throws com.liferay.portal.kernel.exception.PortalException, 103 com.liferay.portal.kernel.exception.SystemException { 104 _userGroupService.deleteUserGroup(userGroupId); 105 } 106 107 /** 108 * Returns the user group with the primary key. 109 * 110 * @param userGroupId the primary key of the user group 111 * @return Returns the user group with the primary key 112 * @throws PortalException if a user group with the primary key could not 113 be found or if the user did not have permission to view the user 114 group 115 * @throws SystemException if a system exception occurred 116 */ 117 public com.liferay.portal.model.UserGroup getUserGroup(long userGroupId) 118 throws com.liferay.portal.kernel.exception.PortalException, 119 com.liferay.portal.kernel.exception.SystemException { 120 return _userGroupService.getUserGroup(userGroupId); 121 } 122 123 /** 124 * Returns the user group with the name. 125 * 126 * @param name the user group's name 127 * @return Returns the user group with the name 128 * @throws PortalException if a user group with the name could not be found 129 or if the user did not have permission to view the user group 130 * @throws SystemException if a system exception occurred 131 */ 132 public com.liferay.portal.model.UserGroup getUserGroup( 133 java.lang.String name) 134 throws com.liferay.portal.kernel.exception.PortalException, 135 com.liferay.portal.kernel.exception.SystemException { 136 return _userGroupService.getUserGroup(name); 137 } 138 139 /** 140 * Returns all the user groups to which the user belongs. 141 * 142 * @param userId the primary key of the user 143 * @return the user groups to which the user belongs 144 * @throws SystemException if a system exception occurred 145 */ 146 public java.util.List<com.liferay.portal.model.UserGroup> getUserUserGroups( 147 long userId) throws com.liferay.portal.kernel.exception.SystemException { 148 return _userGroupService.getUserUserGroups(userId); 149 } 150 151 /** 152 * Removes the user groups from the group. 153 * 154 * @param groupId the primary key of the group 155 * @param userGroupIds the primary keys of the user groups 156 * @throws PortalException if the user did not have permission to assign 157 group members 158 * @throws SystemException if a system exception occurred 159 */ 160 public void unsetGroupUserGroups(long groupId, long[] userGroupIds) 161 throws com.liferay.portal.kernel.exception.PortalException, 162 com.liferay.portal.kernel.exception.SystemException { 163 _userGroupService.unsetGroupUserGroups(groupId, userGroupIds); 164 } 165 166 /** 167 * Removes the user groups from the team. 168 * 169 * @param teamId the primary key of the team 170 * @param userGroupIds the primary keys of the user groups 171 * @throws PortalException if the user did not have permission to assign 172 team members 173 * @throws SystemException if a system exception occurred 174 */ 175 public void unsetTeamUserGroups(long teamId, long[] userGroupIds) 176 throws com.liferay.portal.kernel.exception.PortalException, 177 com.liferay.portal.kernel.exception.SystemException { 178 _userGroupService.unsetTeamUserGroups(teamId, userGroupIds); 179 } 180 181 /** 182 * Updates the user group. 183 * 184 * @param userGroupId the primary key of the user group 185 * @param name the user group's name 186 * @param description the the user group's description 187 * @param publicLayoutSetPrototypeId the primary key of the user group's 188 public layout set 189 * @param privateLayoutSetPrototypeId the primary key of the user group's 190 private layout set 191 * @return the user group 192 * @throws PortalException if a user group with the primary key was not 193 found, if the new information was invalid, or if the user did 194 not have permission to update the user group information 195 * @throws SystemException if a system exception occurred 196 */ 197 public com.liferay.portal.model.UserGroup updateUserGroup( 198 long userGroupId, java.lang.String name, java.lang.String description, 199 long publicLayoutSetPrototypeId, long privateLayoutSetPrototypeId) 200 throws com.liferay.portal.kernel.exception.PortalException, 201 com.liferay.portal.kernel.exception.SystemException { 202 return _userGroupService.updateUserGroup(userGroupId, name, 203 description, publicLayoutSetPrototypeId, privateLayoutSetPrototypeId); 204 } 205 206 /** 207 * @deprecated Renamed to {@link #getWrappedService} 208 */ 209 public UserGroupService getWrappedUserGroupService() { 210 return _userGroupService; 211 } 212 213 /** 214 * @deprecated Renamed to {@link #setWrappedService} 215 */ 216 public void setWrappedUserGroupService(UserGroupService userGroupService) { 217 _userGroupService = userGroupService; 218 } 219 220 public UserGroupService getWrappedService() { 221 return _userGroupService; 222 } 223 224 public void setWrappedService(UserGroupService userGroupService) { 225 _userGroupService = userGroupService; 226 } 227 228 private UserGroupService _userGroupService; 229 }