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