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