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