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