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 groupId, int roleType);
105    
106            public void deleteUserGroupRoles(long userId, long groupId, long[] roleIds);
107    
108            public void deleteUserGroupRoles(long userId, long[] groupIds);
109    
110            public void deleteUserGroupRoles(long[] userIds, long groupId);
111    
112            public void deleteUserGroupRoles(long[] userIds, long groupId, long roleId);
113    
114            public void deleteUserGroupRoles(long[] userIds, long groupId, int roleType);
115    
116            public void deleteUserGroupRolesByGroupId(long groupId);
117    
118            public void deleteUserGroupRolesByRoleId(long roleId);
119    
120            public void deleteUserGroupRolesByUserId(long userId);
121    
122            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
123    
124            /**
125            * Performs a dynamic query on the database and returns the matching rows.
126            *
127            * @param dynamicQuery the dynamic query
128            * @return the matching rows
129            */
130            public <T> java.util.List<T> dynamicQuery(
131                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
132    
133            /**
134            * Performs a dynamic query on the database and returns a range of the matching rows.
135            *
136            * <p>
137            * 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.
138            * </p>
139            *
140            * @param dynamicQuery the dynamic query
141            * @param start the lower bound of the range of model instances
142            * @param end the upper bound of the range of model instances (not inclusive)
143            * @return the range of matching rows
144            */
145            public <T> java.util.List<T> dynamicQuery(
146                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
147                    int end);
148    
149            /**
150            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
151            *
152            * <p>
153            * 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.
154            * </p>
155            *
156            * @param dynamicQuery the dynamic query
157            * @param start the lower bound of the range of model instances
158            * @param end the upper bound of the range of model instances (not inclusive)
159            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
160            * @return the ordered range of matching rows
161            */
162            public <T> java.util.List<T> dynamicQuery(
163                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
164                    int end,
165                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
166    
167            /**
168            * Returns the number of rows matching the dynamic query.
169            *
170            * @param dynamicQuery the dynamic query
171            * @return the number of rows matching the dynamic query
172            */
173            public long dynamicQueryCount(
174                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
175    
176            /**
177            * Returns the number of rows matching the dynamic query.
178            *
179            * @param dynamicQuery the dynamic query
180            * @param projection the projection to apply to the query
181            * @return the number of rows matching the dynamic query
182            */
183            public long dynamicQueryCount(
184                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
185                    com.liferay.portal.kernel.dao.orm.Projection projection);
186    
187            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
188            public com.liferay.portal.model.UserGroupRole fetchUserGroupRole(
189                    com.liferay.portal.service.persistence.UserGroupRolePK userGroupRolePK);
190    
191            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
192            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
193    
194            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
195            public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
196    
197            /**
198            * Returns the OSGi service identifier.
199            *
200            * @return the OSGi service identifier
201            */
202            public java.lang.String getOSGiServiceIdentifier();
203    
204            @Override
205            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
206            public com.liferay.portal.model.PersistedModel getPersistedModel(
207                    java.io.Serializable primaryKeyObj) throws PortalException;
208    
209            /**
210            * Returns the user group role with the primary key.
211            *
212            * @param userGroupRolePK the primary key of the user group role
213            * @return the user group role
214            * @throws PortalException if a user group role with the primary key could not be found
215            */
216            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
217            public com.liferay.portal.model.UserGroupRole getUserGroupRole(
218                    com.liferay.portal.service.persistence.UserGroupRolePK userGroupRolePK)
219                    throws PortalException;
220    
221            /**
222            * Returns a range of all the user group roles.
223            *
224            * <p>
225            * 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.
226            * </p>
227            *
228            * @param start the lower bound of the range of user group roles
229            * @param end the upper bound of the range of user group roles (not inclusive)
230            * @return the range of user group roles
231            */
232            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
233            public java.util.List<com.liferay.portal.model.UserGroupRole> getUserGroupRoles(
234                    int start, int end);
235    
236            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
237            public java.util.List<com.liferay.portal.model.UserGroupRole> getUserGroupRoles(
238                    long userId);
239    
240            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
241            public java.util.List<com.liferay.portal.model.UserGroupRole> getUserGroupRoles(
242                    long userId, long groupId);
243    
244            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
245            public java.util.List<com.liferay.portal.model.UserGroupRole> getUserGroupRoles(
246                    long userId, long groupId, int start, int end);
247    
248            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
249            public java.util.List<com.liferay.portal.model.UserGroupRole> getUserGroupRolesByGroup(
250                    long groupId);
251    
252            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
253            public java.util.List<com.liferay.portal.model.UserGroupRole> getUserGroupRolesByGroupAndRole(
254                    long groupId, long roleId);
255    
256            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
257            public java.util.List<com.liferay.portal.model.UserGroupRole> getUserGroupRolesByUserUserGroupAndGroup(
258                    long userId, long groupId);
259    
260            /**
261            * Returns the number of user group roles.
262            *
263            * @return the number of user group roles
264            */
265            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
266            public int getUserGroupRolesCount();
267    
268            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
269            public int getUserGroupRolesCount(long userId, long groupId);
270    
271            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
272            public boolean hasUserGroupRole(long userId, long groupId, long roleId);
273    
274            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
275            public boolean hasUserGroupRole(long userId, long groupId, long roleId,
276                    boolean inherit);
277    
278            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
279            public boolean hasUserGroupRole(long userId, long groupId,
280                    java.lang.String roleName) throws PortalException;
281    
282            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
283            public boolean hasUserGroupRole(long userId, long groupId,
284                    java.lang.String roleName, boolean inherit) throws PortalException;
285    
286            /**
287            * Updates the user group role in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
288            *
289            * @param userGroupRole the user group role
290            * @return the user group role that was updated
291            */
292            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
293            public com.liferay.portal.model.UserGroupRole updateUserGroupRole(
294                    com.liferay.portal.model.UserGroupRole userGroupRole);
295    }