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