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