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.kernel.service;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
020    import com.liferay.portal.kernel.dao.orm.DynamicQuery;
021    import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery;
022    import com.liferay.portal.kernel.dao.orm.Projection;
023    import com.liferay.portal.kernel.exception.PortalException;
024    import com.liferay.portal.kernel.exception.SystemException;
025    import com.liferay.portal.kernel.model.PersistedModel;
026    import com.liferay.portal.kernel.model.UserIdMapper;
027    import com.liferay.portal.kernel.search.Indexable;
028    import com.liferay.portal.kernel.search.IndexableType;
029    import com.liferay.portal.kernel.transaction.Isolation;
030    import com.liferay.portal.kernel.transaction.Propagation;
031    import com.liferay.portal.kernel.transaction.Transactional;
032    import com.liferay.portal.kernel.util.OrderByComparator;
033    
034    import java.io.Serializable;
035    
036    import java.util.List;
037    
038    /**
039     * Provides the local service interface for UserIdMapper. Methods of this
040     * service will not have security checks based on the propagated JAAS
041     * credentials because this service can only be accessed from within the same
042     * VM.
043     *
044     * @author Brian Wing Shun Chan
045     * @see UserIdMapperLocalServiceUtil
046     * @see com.liferay.portal.service.base.UserIdMapperLocalServiceBaseImpl
047     * @see com.liferay.portal.service.impl.UserIdMapperLocalServiceImpl
048     * @generated
049     */
050    @ProviderType
051    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
052            PortalException.class, SystemException.class})
053    public interface UserIdMapperLocalService extends BaseLocalService,
054            PersistedModelLocalService {
055            /*
056             * NOTE FOR DEVELOPERS:
057             *
058             * Never modify or reference this interface directly. Always use {@link UserIdMapperLocalServiceUtil} to access the user ID mapper local service. Add custom service methods to {@link com.liferay.portal.service.impl.UserIdMapperLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
059             */
060            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
061            public ActionableDynamicQuery getActionableDynamicQuery();
062    
063            public DynamicQuery dynamicQuery();
064    
065            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
066            public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
067    
068            /**
069            * @throws PortalException
070            */
071            @Override
072            public PersistedModel deletePersistedModel(PersistedModel persistedModel)
073                    throws PortalException;
074    
075            @Override
076            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
077            public PersistedModel getPersistedModel(Serializable primaryKeyObj)
078                    throws PortalException;
079    
080            /**
081            * Adds the user ID mapper to the database. Also notifies the appropriate model listeners.
082            *
083            * @param userIdMapper the user ID mapper
084            * @return the user ID mapper that was added
085            */
086            @Indexable(type = IndexableType.REINDEX)
087            public UserIdMapper addUserIdMapper(UserIdMapper userIdMapper);
088    
089            /**
090            * Creates a new user ID mapper with the primary key. Does not add the user ID mapper to the database.
091            *
092            * @param userIdMapperId the primary key for the new user ID mapper
093            * @return the new user ID mapper
094            */
095            public UserIdMapper createUserIdMapper(long userIdMapperId);
096    
097            /**
098            * Deletes the user ID mapper from the database. Also notifies the appropriate model listeners.
099            *
100            * @param userIdMapper the user ID mapper
101            * @return the user ID mapper that was removed
102            */
103            @Indexable(type = IndexableType.DELETE)
104            public UserIdMapper deleteUserIdMapper(UserIdMapper userIdMapper);
105    
106            /**
107            * Deletes the user ID mapper with the primary key from the database. Also notifies the appropriate model listeners.
108            *
109            * @param userIdMapperId the primary key of the user ID mapper
110            * @return the user ID mapper that was removed
111            * @throws PortalException if a user ID mapper with the primary key could not be found
112            */
113            @Indexable(type = IndexableType.DELETE)
114            public UserIdMapper deleteUserIdMapper(long userIdMapperId)
115                    throws PortalException;
116    
117            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
118            public UserIdMapper fetchUserIdMapper(long userIdMapperId);
119    
120            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
121            public UserIdMapper getUserIdMapper(long userId, java.lang.String type)
122                    throws PortalException;
123    
124            /**
125            * Returns the user ID mapper with the primary key.
126            *
127            * @param userIdMapperId the primary key of the user ID mapper
128            * @return the user ID mapper
129            * @throws PortalException if a user ID mapper with the primary key could not be found
130            */
131            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
132            public UserIdMapper getUserIdMapper(long userIdMapperId)
133                    throws PortalException;
134    
135            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
136            public UserIdMapper getUserIdMapperByExternalUserId(java.lang.String type,
137                    java.lang.String externalUserId) throws PortalException;
138    
139            /**
140            * Updates the user ID mapper in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
141            *
142            * @param userIdMapper the user ID mapper
143            * @return the user ID mapper that was updated
144            */
145            @Indexable(type = IndexableType.REINDEX)
146            public UserIdMapper updateUserIdMapper(UserIdMapper userIdMapper);
147    
148            public UserIdMapper updateUserIdMapper(long userId, java.lang.String type,
149                    java.lang.String description, java.lang.String externalUserId);
150    
151            /**
152            * Returns the number of user ID mappers.
153            *
154            * @return the number of user ID mappers
155            */
156            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
157            public int getUserIdMappersCount();
158    
159            /**
160            * Returns the OSGi service identifier.
161            *
162            * @return the OSGi service identifier
163            */
164            public java.lang.String getOSGiServiceIdentifier();
165    
166            /**
167            * Performs a dynamic query on the database and returns the matching rows.
168            *
169            * @param dynamicQuery the dynamic query
170            * @return the matching rows
171            */
172            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery);
173    
174            /**
175            * Performs a dynamic query on the database and returns a range of the matching rows.
176            *
177            * <p>
178            * 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.
179            * </p>
180            *
181            * @param dynamicQuery the dynamic query
182            * @param start the lower bound of the range of model instances
183            * @param end the upper bound of the range of model instances (not inclusive)
184            * @return the range of matching rows
185            */
186            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
187                    int end);
188    
189            /**
190            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
191            *
192            * <p>
193            * 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.
194            * </p>
195            *
196            * @param dynamicQuery the dynamic query
197            * @param start the lower bound of the range of model instances
198            * @param end the upper bound of the range of model instances (not inclusive)
199            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
200            * @return the ordered range of matching rows
201            */
202            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
203                    int end, OrderByComparator<T> orderByComparator);
204    
205            /**
206            * Returns a range of all the user ID mappers.
207            *
208            * <p>
209            * 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.
210            * </p>
211            *
212            * @param start the lower bound of the range of user ID mappers
213            * @param end the upper bound of the range of user ID mappers (not inclusive)
214            * @return the range of user ID mappers
215            */
216            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
217            public List<UserIdMapper> getUserIdMappers(int start, int end);
218    
219            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
220            public List<UserIdMapper> getUserIdMappers(long userId);
221    
222            /**
223            * Returns the number of rows matching the dynamic query.
224            *
225            * @param dynamicQuery the dynamic query
226            * @return the number of rows matching the dynamic query
227            */
228            public long dynamicQueryCount(DynamicQuery dynamicQuery);
229    
230            /**
231            * Returns the number of rows matching the dynamic query.
232            *
233            * @param dynamicQuery the dynamic query
234            * @param projection the projection to apply to the query
235            * @return the number of rows matching the dynamic query
236            */
237            public long dynamicQueryCount(DynamicQuery dynamicQuery,
238                    Projection projection);
239    
240            public void deleteUserIdMappers(long userId);
241    }