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    
061            /**
062            * Adds the user ID mapper to the database. Also notifies the appropriate model listeners.
063            *
064            * @param userIdMapper the user ID mapper
065            * @return the user ID mapper that was added
066            */
067            @Indexable(type = IndexableType.REINDEX)
068            public UserIdMapper addUserIdMapper(UserIdMapper userIdMapper);
069    
070            /**
071            * Creates a new user ID mapper with the primary key. Does not add the user ID mapper to the database.
072            *
073            * @param userIdMapperId the primary key for the new user ID mapper
074            * @return the new user ID mapper
075            */
076            public UserIdMapper createUserIdMapper(long userIdMapperId);
077    
078            /**
079            * @throws PortalException
080            */
081            @Override
082            public PersistedModel deletePersistedModel(PersistedModel persistedModel)
083                    throws PortalException;
084    
085            /**
086            * Deletes the user ID mapper from the database. Also notifies the appropriate model listeners.
087            *
088            * @param userIdMapper the user ID mapper
089            * @return the user ID mapper that was removed
090            */
091            @Indexable(type = IndexableType.DELETE)
092            public UserIdMapper deleteUserIdMapper(UserIdMapper userIdMapper);
093    
094            /**
095            * Deletes the user ID mapper with the primary key from the database. Also notifies the appropriate model listeners.
096            *
097            * @param userIdMapperId the primary key of the user ID mapper
098            * @return the user ID mapper that was removed
099            * @throws PortalException if a user ID mapper with the primary key could not be found
100            */
101            @Indexable(type = IndexableType.DELETE)
102            public UserIdMapper deleteUserIdMapper(long userIdMapperId)
103                    throws PortalException;
104    
105            public void deleteUserIdMappers(long userId);
106    
107            public DynamicQuery dynamicQuery();
108    
109            /**
110            * Performs a dynamic query on the database and returns the matching rows.
111            *
112            * @param dynamicQuery the dynamic query
113            * @return the matching rows
114            */
115            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery);
116    
117            /**
118            * Performs a dynamic query on the database and returns a range of the matching rows.
119            *
120            * <p>
121            * 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.
122            * </p>
123            *
124            * @param dynamicQuery the dynamic query
125            * @param start the lower bound of the range of model instances
126            * @param end the upper bound of the range of model instances (not inclusive)
127            * @return the range of matching rows
128            */
129            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
130                    int end);
131    
132            /**
133            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
134            *
135            * <p>
136            * 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.
137            * </p>
138            *
139            * @param dynamicQuery the dynamic query
140            * @param start the lower bound of the range of model instances
141            * @param end the upper bound of the range of model instances (not inclusive)
142            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
143            * @return the ordered range of matching rows
144            */
145            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
146                    int end, OrderByComparator<T> orderByComparator);
147    
148            /**
149            * Returns the number of rows matching the dynamic query.
150            *
151            * @param dynamicQuery the dynamic query
152            * @return the number of rows matching the dynamic query
153            */
154            public long dynamicQueryCount(DynamicQuery dynamicQuery);
155    
156            /**
157            * Returns the number of rows matching the dynamic query.
158            *
159            * @param dynamicQuery the dynamic query
160            * @param projection the projection to apply to the query
161            * @return the number of rows matching the dynamic query
162            */
163            public long dynamicQueryCount(DynamicQuery dynamicQuery,
164                    Projection projection);
165    
166            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
167            public UserIdMapper fetchUserIdMapper(long userIdMapperId);
168    
169            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
170            public ActionableDynamicQuery getActionableDynamicQuery();
171    
172            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
173            public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
174    
175            /**
176            * Returns the OSGi service identifier.
177            *
178            * @return the OSGi service identifier
179            */
180            public java.lang.String getOSGiServiceIdentifier();
181    
182            @Override
183            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
184            public PersistedModel getPersistedModel(Serializable primaryKeyObj)
185                    throws PortalException;
186    
187            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
188            public UserIdMapper getUserIdMapper(long userId, java.lang.String type)
189                    throws PortalException;
190    
191            /**
192            * Returns the user ID mapper with the primary key.
193            *
194            * @param userIdMapperId the primary key of the user ID mapper
195            * @return the user ID mapper
196            * @throws PortalException if a user ID mapper with the primary key could not be found
197            */
198            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
199            public UserIdMapper getUserIdMapper(long userIdMapperId)
200                    throws PortalException;
201    
202            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
203            public UserIdMapper getUserIdMapperByExternalUserId(java.lang.String type,
204                    java.lang.String externalUserId) throws PortalException;
205    
206            /**
207            * Returns a range of all the user ID mappers.
208            *
209            * <p>
210            * 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.
211            * </p>
212            *
213            * @param start the lower bound of the range of user ID mappers
214            * @param end the upper bound of the range of user ID mappers (not inclusive)
215            * @return the range of user ID mappers
216            */
217            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
218            public List<UserIdMapper> getUserIdMappers(int start, int end);
219    
220            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
221            public List<UserIdMapper> getUserIdMappers(long userId);
222    
223            /**
224            * Returns the number of user ID mappers.
225            *
226            * @return the number of user ID mappers
227            */
228            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
229            public int getUserIdMappersCount();
230    
231            public UserIdMapper updateUserIdMapper(long userId, java.lang.String type,
232                    java.lang.String description, java.lang.String externalUserId);
233    
234            /**
235            * Updates the user ID mapper in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
236            *
237            * @param userIdMapper the user ID mapper
238            * @return the user ID mapper that was updated
239            */
240            @Indexable(type = IndexableType.REINDEX)
241            public UserIdMapper updateUserIdMapper(UserIdMapper userIdMapper);
242    }