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.bean.PortalBeanLocatorUtil;
020    import com.liferay.portal.kernel.util.ReferenceRegistry;
021    
022    /**
023     * Provides the local service utility for UserIdMapper. This utility wraps
024     * {@link com.liferay.portal.service.impl.UserIdMapperLocalServiceImpl} and is the
025     * primary access point for service operations in application layer code running
026     * on the local server. Methods of this service will not have security checks
027     * based on the propagated JAAS credentials because this service can only be
028     * accessed from within the same VM.
029     *
030     * @author Brian Wing Shun Chan
031     * @see UserIdMapperLocalService
032     * @see com.liferay.portal.service.base.UserIdMapperLocalServiceBaseImpl
033     * @see com.liferay.portal.service.impl.UserIdMapperLocalServiceImpl
034     * @generated
035     */
036    @ProviderType
037    public class UserIdMapperLocalServiceUtil {
038            /*
039             * NOTE FOR DEVELOPERS:
040             *
041             * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.UserIdMapperLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
042             */
043    
044            /**
045            * Adds the user ID mapper to the database. Also notifies the appropriate model listeners.
046            *
047            * @param userIdMapper the user ID mapper
048            * @return the user ID mapper that was added
049            */
050            public static com.liferay.portal.model.UserIdMapper addUserIdMapper(
051                    com.liferay.portal.model.UserIdMapper userIdMapper) {
052                    return getService().addUserIdMapper(userIdMapper);
053            }
054    
055            /**
056            * Creates a new user ID mapper with the primary key. Does not add the user ID mapper to the database.
057            *
058            * @param userIdMapperId the primary key for the new user ID mapper
059            * @return the new user ID mapper
060            */
061            public static com.liferay.portal.model.UserIdMapper createUserIdMapper(
062                    long userIdMapperId) {
063                    return getService().createUserIdMapper(userIdMapperId);
064            }
065    
066            /**
067            * @throws PortalException
068            */
069            public static com.liferay.portal.model.PersistedModel deletePersistedModel(
070                    com.liferay.portal.model.PersistedModel persistedModel)
071                    throws com.liferay.portal.kernel.exception.PortalException {
072                    return getService().deletePersistedModel(persistedModel);
073            }
074    
075            /**
076            * Deletes the user ID mapper from the database. Also notifies the appropriate model listeners.
077            *
078            * @param userIdMapper the user ID mapper
079            * @return the user ID mapper that was removed
080            */
081            public static com.liferay.portal.model.UserIdMapper deleteUserIdMapper(
082                    com.liferay.portal.model.UserIdMapper userIdMapper) {
083                    return getService().deleteUserIdMapper(userIdMapper);
084            }
085    
086            /**
087            * Deletes the user ID mapper with the primary key from the database. Also notifies the appropriate model listeners.
088            *
089            * @param userIdMapperId the primary key of the user ID mapper
090            * @return the user ID mapper that was removed
091            * @throws PortalException if a user ID mapper with the primary key could not be found
092            */
093            public static com.liferay.portal.model.UserIdMapper deleteUserIdMapper(
094                    long userIdMapperId)
095                    throws com.liferay.portal.kernel.exception.PortalException {
096                    return getService().deleteUserIdMapper(userIdMapperId);
097            }
098    
099            public static void deleteUserIdMappers(long userId) {
100                    getService().deleteUserIdMappers(userId);
101            }
102    
103            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
104                    return getService().dynamicQuery();
105            }
106    
107            /**
108            * Performs a dynamic query on the database and returns the matching rows.
109            *
110            * @param dynamicQuery the dynamic query
111            * @return the matching rows
112            */
113            public static <T> java.util.List<T> dynamicQuery(
114                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) {
115                    return getService().dynamicQuery(dynamicQuery);
116            }
117    
118            /**
119            * Performs a dynamic query on the database and returns a 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. 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.UserIdMapperModelImpl}. 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.
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            * @return the range of matching rows
129            */
130            public static <T> java.util.List<T> dynamicQuery(
131                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
132                    int end) {
133                    return getService().dynamicQuery(dynamicQuery, start, end);
134            }
135    
136            /**
137            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
138            *
139            * <p>
140            * 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.UserIdMapperModelImpl}. 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.
141            * </p>
142            *
143            * @param dynamicQuery the dynamic query
144            * @param start the lower bound of the range of model instances
145            * @param end the upper bound of the range of model instances (not inclusive)
146            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
147            * @return the ordered range of matching rows
148            */
149            public static <T> java.util.List<T> dynamicQuery(
150                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
151                    int end,
152                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) {
153                    return getService()
154                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
155            }
156    
157            /**
158            * Returns the number of rows matching the dynamic query.
159            *
160            * @param dynamicQuery the dynamic query
161            * @return the number of rows matching the dynamic query
162            */
163            public static long dynamicQueryCount(
164                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) {
165                    return getService().dynamicQueryCount(dynamicQuery);
166            }
167    
168            /**
169            * Returns the number of rows matching the dynamic query.
170            *
171            * @param dynamicQuery the dynamic query
172            * @param projection the projection to apply to the query
173            * @return the number of rows matching the dynamic query
174            */
175            public static long dynamicQueryCount(
176                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
177                    com.liferay.portal.kernel.dao.orm.Projection projection) {
178                    return getService().dynamicQueryCount(dynamicQuery, projection);
179            }
180    
181            public static com.liferay.portal.model.UserIdMapper fetchUserIdMapper(
182                    long userIdMapperId) {
183                    return getService().fetchUserIdMapper(userIdMapperId);
184            }
185    
186            public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() {
187                    return getService().getActionableDynamicQuery();
188            }
189    
190            /**
191            * Returns the OSGi service identifier.
192            *
193            * @return the OSGi service identifier
194            */
195            public static java.lang.String getOSGiServiceIdentifier() {
196                    return getService().getOSGiServiceIdentifier();
197            }
198    
199            public static com.liferay.portal.model.PersistedModel getPersistedModel(
200                    java.io.Serializable primaryKeyObj)
201                    throws com.liferay.portal.kernel.exception.PortalException {
202                    return getService().getPersistedModel(primaryKeyObj);
203            }
204    
205            public static com.liferay.portal.model.UserIdMapper getUserIdMapper(
206                    long userId, java.lang.String type)
207                    throws com.liferay.portal.kernel.exception.PortalException {
208                    return getService().getUserIdMapper(userId, type);
209            }
210    
211            /**
212            * Returns the user ID mapper with the primary key.
213            *
214            * @param userIdMapperId the primary key of the user ID mapper
215            * @return the user ID mapper
216            * @throws PortalException if a user ID mapper with the primary key could not be found
217            */
218            public static com.liferay.portal.model.UserIdMapper getUserIdMapper(
219                    long userIdMapperId)
220                    throws com.liferay.portal.kernel.exception.PortalException {
221                    return getService().getUserIdMapper(userIdMapperId);
222            }
223    
224            public static com.liferay.portal.model.UserIdMapper getUserIdMapperByExternalUserId(
225                    java.lang.String type, java.lang.String externalUserId)
226                    throws com.liferay.portal.kernel.exception.PortalException {
227                    return getService().getUserIdMapperByExternalUserId(type, externalUserId);
228            }
229    
230            /**
231            * Returns a range of all the user ID mappers.
232            *
233            * <p>
234            * 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.UserIdMapperModelImpl}. 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.
235            * </p>
236            *
237            * @param start the lower bound of the range of user ID mappers
238            * @param end the upper bound of the range of user ID mappers (not inclusive)
239            * @return the range of user ID mappers
240            */
241            public static java.util.List<com.liferay.portal.model.UserIdMapper> getUserIdMappers(
242                    int start, int end) {
243                    return getService().getUserIdMappers(start, end);
244            }
245    
246            public static java.util.List<com.liferay.portal.model.UserIdMapper> getUserIdMappers(
247                    long userId) {
248                    return getService().getUserIdMappers(userId);
249            }
250    
251            /**
252            * Returns the number of user ID mappers.
253            *
254            * @return the number of user ID mappers
255            */
256            public static int getUserIdMappersCount() {
257                    return getService().getUserIdMappersCount();
258            }
259    
260            public static com.liferay.portal.model.UserIdMapper updateUserIdMapper(
261                    long userId, java.lang.String type, java.lang.String description,
262                    java.lang.String externalUserId) {
263                    return getService()
264                                       .updateUserIdMapper(userId, type, description, externalUserId);
265            }
266    
267            /**
268            * Updates the user ID mapper in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
269            *
270            * @param userIdMapper the user ID mapper
271            * @return the user ID mapper that was updated
272            */
273            public static com.liferay.portal.model.UserIdMapper updateUserIdMapper(
274                    com.liferay.portal.model.UserIdMapper userIdMapper) {
275                    return getService().updateUserIdMapper(userIdMapper);
276            }
277    
278            public static UserIdMapperLocalService getService() {
279                    if (_service == null) {
280                            _service = (UserIdMapperLocalService)PortalBeanLocatorUtil.locate(UserIdMapperLocalService.class.getName());
281    
282                            ReferenceRegistry.registerReference(UserIdMapperLocalServiceUtil.class,
283                                    "_service");
284                    }
285    
286                    return _service;
287            }
288    
289            /**
290             * @deprecated As of 6.2.0
291             */
292            @Deprecated
293            public void setService(UserIdMapperLocalService service) {
294            }
295    
296            private static UserIdMapperLocalService _service;
297    }