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.BrowserTracker;
026    import com.liferay.portal.kernel.model.PersistedModel;
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 BrowserTracker. 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 BrowserTrackerLocalServiceUtil
046     * @see com.liferay.portal.service.base.BrowserTrackerLocalServiceBaseImpl
047     * @see com.liferay.portal.service.impl.BrowserTrackerLocalServiceImpl
048     * @generated
049     */
050    @ProviderType
051    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
052            PortalException.class, SystemException.class})
053    public interface BrowserTrackerLocalService extends BaseLocalService,
054            PersistedModelLocalService {
055            /*
056             * NOTE FOR DEVELOPERS:
057             *
058             * Never modify or reference this interface directly. Always use {@link BrowserTrackerLocalServiceUtil} to access the browser tracker local service. Add custom service methods to {@link com.liferay.portal.service.impl.BrowserTrackerLocalServiceImpl} 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            * Adds the browser tracker to the database. Also notifies the appropriate model listeners.
070            *
071            * @param browserTracker the browser tracker
072            * @return the browser tracker that was added
073            */
074            @Indexable(type = IndexableType.REINDEX)
075            public BrowserTracker addBrowserTracker(BrowserTracker browserTracker);
076    
077            /**
078            * Creates a new browser tracker with the primary key. Does not add the browser tracker to the database.
079            *
080            * @param browserTrackerId the primary key for the new browser tracker
081            * @return the new browser tracker
082            */
083            public BrowserTracker createBrowserTracker(long browserTrackerId);
084    
085            /**
086            * Deletes the browser tracker from the database. Also notifies the appropriate model listeners.
087            *
088            * @param browserTracker the browser tracker
089            * @return the browser tracker that was removed
090            */
091            @Indexable(type = IndexableType.DELETE)
092            public BrowserTracker deleteBrowserTracker(BrowserTracker browserTracker);
093    
094            /**
095            * Deletes the browser tracker with the primary key from the database. Also notifies the appropriate model listeners.
096            *
097            * @param browserTrackerId the primary key of the browser tracker
098            * @return the browser tracker that was removed
099            * @throws PortalException if a browser tracker with the primary key could not be found
100            */
101            @Indexable(type = IndexableType.DELETE)
102            public BrowserTracker deleteBrowserTracker(long browserTrackerId)
103                    throws PortalException;
104    
105            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
106            public BrowserTracker fetchBrowserTracker(long browserTrackerId);
107    
108            /**
109            * Returns the browser tracker with the primary key.
110            *
111            * @param browserTrackerId the primary key of the browser tracker
112            * @return the browser tracker
113            * @throws PortalException if a browser tracker with the primary key could not be found
114            */
115            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
116            public BrowserTracker getBrowserTracker(long browserTrackerId)
117                    throws PortalException;
118    
119            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
120            public BrowserTracker getBrowserTracker(long userId, long browserKey);
121    
122            /**
123            * Updates the browser tracker in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
124            *
125            * @param browserTracker the browser tracker
126            * @return the browser tracker that was updated
127            */
128            @Indexable(type = IndexableType.REINDEX)
129            public BrowserTracker updateBrowserTracker(BrowserTracker browserTracker);
130    
131            public BrowserTracker updateBrowserTracker(long userId, long browserKey);
132    
133            /**
134            * @throws PortalException
135            */
136            @Override
137            public PersistedModel deletePersistedModel(PersistedModel persistedModel)
138                    throws PortalException;
139    
140            @Override
141            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
142            public PersistedModel getPersistedModel(Serializable primaryKeyObj)
143                    throws PortalException;
144    
145            /**
146            * Returns the number of browser trackers.
147            *
148            * @return the number of browser trackers
149            */
150            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
151            public int getBrowserTrackersCount();
152    
153            /**
154            * Returns the OSGi service identifier.
155            *
156            * @return the OSGi service identifier
157            */
158            public java.lang.String getOSGiServiceIdentifier();
159    
160            /**
161            * Performs a dynamic query on the database and returns the matching rows.
162            *
163            * @param dynamicQuery the dynamic query
164            * @return the matching rows
165            */
166            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery);
167    
168            /**
169            * Performs a dynamic query on the database and returns a range of the matching rows.
170            *
171            * <p>
172            * 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.BrowserTrackerModelImpl}. 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.
173            * </p>
174            *
175            * @param dynamicQuery the dynamic query
176            * @param start the lower bound of the range of model instances
177            * @param end the upper bound of the range of model instances (not inclusive)
178            * @return the range of matching rows
179            */
180            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
181                    int end);
182    
183            /**
184            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
185            *
186            * <p>
187            * 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.BrowserTrackerModelImpl}. 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.
188            * </p>
189            *
190            * @param dynamicQuery the dynamic query
191            * @param start the lower bound of the range of model instances
192            * @param end the upper bound of the range of model instances (not inclusive)
193            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
194            * @return the ordered range of matching rows
195            */
196            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
197                    int end, OrderByComparator<T> orderByComparator);
198    
199            /**
200            * Returns a range of all the browser trackers.
201            *
202            * <p>
203            * 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.BrowserTrackerModelImpl}. 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.
204            * </p>
205            *
206            * @param start the lower bound of the range of browser trackers
207            * @param end the upper bound of the range of browser trackers (not inclusive)
208            * @return the range of browser trackers
209            */
210            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
211            public List<BrowserTracker> getBrowserTrackers(int start, int end);
212    
213            /**
214            * Returns the number of rows matching the dynamic query.
215            *
216            * @param dynamicQuery the dynamic query
217            * @return the number of rows matching the dynamic query
218            */
219            public long dynamicQueryCount(DynamicQuery dynamicQuery);
220    
221            /**
222            * Returns the number of rows matching the dynamic query.
223            *
224            * @param dynamicQuery the dynamic query
225            * @param projection the projection to apply to the query
226            * @return the number of rows matching the dynamic query
227            */
228            public long dynamicQueryCount(DynamicQuery dynamicQuery,
229                    Projection projection);
230    
231            public void deleteUserBrowserTracker(long userId);
232    }