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 UserTracker. 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 UserTrackerLocalServiceUtil
034     * @see com.liferay.portal.service.base.UserTrackerLocalServiceBaseImpl
035     * @see com.liferay.portal.service.impl.UserTrackerLocalServiceImpl
036     * @generated
037     */
038    @ProviderType
039    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
040            PortalException.class, SystemException.class})
041    public interface UserTrackerLocalService extends BaseLocalService,
042            PersistedModelLocalService {
043            /*
044             * NOTE FOR DEVELOPERS:
045             *
046             * Never modify or reference this interface directly. Always use {@link UserTrackerLocalServiceUtil} to access the user tracker local service. Add custom service methods to {@link com.liferay.portal.service.impl.UserTrackerLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
047             */
048            public com.liferay.portal.model.UserTracker addUserTracker(long companyId,
049                    long userId, java.util.Date modifiedDate, java.lang.String sessionId,
050                    java.lang.String remoteAddr, java.lang.String remoteHost,
051                    java.lang.String userAgent,
052                    java.util.List<com.liferay.portal.model.UserTrackerPath> userTrackerPaths);
053    
054            /**
055            * Adds the user tracker to the database. Also notifies the appropriate model listeners.
056            *
057            * @param userTracker the user tracker
058            * @return the user tracker that was added
059            */
060            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
061            public com.liferay.portal.model.UserTracker addUserTracker(
062                    com.liferay.portal.model.UserTracker userTracker);
063    
064            /**
065            * Creates a new user tracker with the primary key. Does not add the user tracker to the database.
066            *
067            * @param userTrackerId the primary key for the new user tracker
068            * @return the new user tracker
069            */
070            public com.liferay.portal.model.UserTracker createUserTracker(
071                    long userTrackerId);
072    
073            /**
074            * @throws PortalException
075            */
076            @Override
077            public com.liferay.portal.model.PersistedModel deletePersistedModel(
078                    com.liferay.portal.model.PersistedModel persistedModel)
079                    throws com.liferay.portal.kernel.exception.PortalException;
080    
081            /**
082            * Deletes the user tracker from the database. Also notifies the appropriate model listeners.
083            *
084            * @param userTracker the user tracker
085            * @return the user tracker that was removed
086            */
087            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
088            public com.liferay.portal.model.UserTracker deleteUserTracker(
089                    com.liferay.portal.model.UserTracker userTracker);
090    
091            /**
092            * Deletes the user tracker with the primary key from the database. Also notifies the appropriate model listeners.
093            *
094            * @param userTrackerId the primary key of the user tracker
095            * @return the user tracker that was removed
096            * @throws PortalException if a user tracker with the primary key could not be found
097            */
098            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
099            public com.liferay.portal.model.UserTracker deleteUserTracker(
100                    long userTrackerId)
101                    throws com.liferay.portal.kernel.exception.PortalException;
102    
103            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
104    
105            /**
106            * Performs a dynamic query on the database and returns the matching rows.
107            *
108            * @param dynamicQuery the dynamic query
109            * @return the matching rows
110            */
111            public <T> java.util.List<T> dynamicQuery(
112                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
113    
114            /**
115            * Performs a dynamic query on the database and returns a range of the matching rows.
116            *
117            * <p>
118            * 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.UserTrackerModelImpl}. 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.
119            * </p>
120            *
121            * @param dynamicQuery the dynamic query
122            * @param start the lower bound of the range of model instances
123            * @param end the upper bound of the range of model instances (not inclusive)
124            * @return the range of matching rows
125            */
126            public <T> java.util.List<T> dynamicQuery(
127                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
128                    int end);
129    
130            /**
131            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
132            *
133            * <p>
134            * 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.UserTrackerModelImpl}. 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.
135            * </p>
136            *
137            * @param dynamicQuery the dynamic query
138            * @param start the lower bound of the range of model instances
139            * @param end the upper bound of the range of model instances (not inclusive)
140            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
141            * @return the ordered 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                    com.liferay.portal.kernel.util.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(
155                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
156    
157            /**
158            * Returns the number of rows matching the dynamic query.
159            *
160            * @param dynamicQuery the dynamic query
161            * @param projection the projection to apply to the query
162            * @return the number of rows matching the dynamic query
163            */
164            public long dynamicQueryCount(
165                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
166                    com.liferay.portal.kernel.dao.orm.Projection projection);
167    
168            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
169            public com.liferay.portal.model.UserTracker fetchUserTracker(
170                    long userTrackerId);
171    
172            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
173            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
174    
175            /**
176            * Returns the Spring bean ID for this bean.
177            *
178            * @return the Spring bean ID for this bean
179            */
180            public java.lang.String getBeanIdentifier();
181    
182            @Override
183            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
184            public com.liferay.portal.model.PersistedModel getPersistedModel(
185                    java.io.Serializable primaryKeyObj)
186                    throws com.liferay.portal.kernel.exception.PortalException;
187    
188            /**
189            * Returns the user tracker with the primary key.
190            *
191            * @param userTrackerId the primary key of the user tracker
192            * @return the user tracker
193            * @throws PortalException if a user tracker with the primary key could not be found
194            */
195            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
196            public com.liferay.portal.model.UserTracker getUserTracker(
197                    long userTrackerId)
198                    throws com.liferay.portal.kernel.exception.PortalException;
199    
200            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
201            public java.util.List<com.liferay.portal.model.UserTracker> getUserTrackers(
202                    long companyId, int start, int end);
203    
204            /**
205            * Returns a range of all the user trackers.
206            *
207            * <p>
208            * 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.UserTrackerModelImpl}. 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.
209            * </p>
210            *
211            * @param start the lower bound of the range of user trackers
212            * @param end the upper bound of the range of user trackers (not inclusive)
213            * @return the range of user trackers
214            */
215            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
216            public java.util.List<com.liferay.portal.model.UserTracker> getUserTrackers(
217                    int start, int end);
218    
219            /**
220            * Returns the number of user trackers.
221            *
222            * @return the number of user trackers
223            */
224            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
225            public int getUserTrackersCount();
226    
227            /**
228            * Sets the Spring bean ID for this bean.
229            *
230            * @param beanIdentifier the Spring bean ID for this bean
231            */
232            public void setBeanIdentifier(java.lang.String beanIdentifier);
233    
234            /**
235            * Updates the user tracker in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
236            *
237            * @param userTracker the user tracker
238            * @return the user tracker that was updated
239            */
240            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
241            public com.liferay.portal.model.UserTracker updateUserTracker(
242                    com.liferay.portal.model.UserTracker userTracker);
243    }