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 import com.liferay.portal.model.SystemEventConstants; 026 027 /** 028 * Provides the local service interface for Phone. Methods of this 029 * service will not have security checks based on the propagated JAAS 030 * credentials because this service can only be accessed from within the same 031 * VM. 032 * 033 * @author Brian Wing Shun Chan 034 * @see PhoneLocalServiceUtil 035 * @see com.liferay.portal.service.base.PhoneLocalServiceBaseImpl 036 * @see com.liferay.portal.service.impl.PhoneLocalServiceImpl 037 * @generated 038 */ 039 @ProviderType 040 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 041 PortalException.class, SystemException.class}) 042 public interface PhoneLocalService extends BaseLocalService, 043 PersistedModelLocalService { 044 /* 045 * NOTE FOR DEVELOPERS: 046 * 047 * Never modify or reference this interface directly. Always use {@link PhoneLocalServiceUtil} to access the phone local service. Add custom service methods to {@link com.liferay.portal.service.impl.PhoneLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 048 */ 049 050 /** 051 * Adds the phone to the database. Also notifies the appropriate model listeners. 052 * 053 * @param phone the phone 054 * @return the phone that was added 055 */ 056 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 057 public com.liferay.portal.model.Phone addPhone( 058 com.liferay.portal.model.Phone phone); 059 060 /** 061 * @deprecated As of 6.2.0, replaced by {@link #addPhone(long, String, long, 062 String, String, int, boolean, ServiceContext)} 063 */ 064 @java.lang.Deprecated 065 public com.liferay.portal.model.Phone addPhone(long userId, 066 java.lang.String className, long classPK, java.lang.String number, 067 java.lang.String extension, long typeId, boolean primary) 068 throws PortalException; 069 070 public com.liferay.portal.model.Phone addPhone(long userId, 071 java.lang.String className, long classPK, java.lang.String number, 072 java.lang.String extension, long typeId, boolean primary, 073 com.liferay.portal.service.ServiceContext serviceContext) 074 throws PortalException; 075 076 /** 077 * Creates a new phone with the primary key. Does not add the phone to the database. 078 * 079 * @param phoneId the primary key for the new phone 080 * @return the new phone 081 */ 082 public com.liferay.portal.model.Phone createPhone(long phoneId); 083 084 /** 085 * @throws PortalException 086 */ 087 @Override 088 public com.liferay.portal.model.PersistedModel deletePersistedModel( 089 com.liferay.portal.model.PersistedModel persistedModel) 090 throws PortalException; 091 092 /** 093 * Deletes the phone from the database. Also notifies the appropriate model listeners. 094 * 095 * @param phone the phone 096 * @return the phone that was removed 097 */ 098 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 099 @com.liferay.portal.kernel.systemevent.SystemEvent(action = SystemEventConstants.ACTION_SKIP, type = SystemEventConstants.TYPE_DELETE) 100 public com.liferay.portal.model.Phone deletePhone( 101 com.liferay.portal.model.Phone phone); 102 103 /** 104 * Deletes the phone with the primary key from the database. Also notifies the appropriate model listeners. 105 * 106 * @param phoneId the primary key of the phone 107 * @return the phone that was removed 108 * @throws PortalException if a phone with the primary key could not be found 109 */ 110 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 111 public com.liferay.portal.model.Phone deletePhone(long phoneId) 112 throws PortalException; 113 114 public void deletePhones(long companyId, java.lang.String className, 115 long classPK); 116 117 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 118 119 /** 120 * Performs a dynamic query on the database and returns the matching rows. 121 * 122 * @param dynamicQuery the dynamic query 123 * @return the matching rows 124 */ 125 public <T> java.util.List<T> dynamicQuery( 126 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 127 128 /** 129 * Performs a dynamic query on the database and returns a range of the matching rows. 130 * 131 * <p> 132 * 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.PhoneModelImpl}. 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. 133 * </p> 134 * 135 * @param dynamicQuery the dynamic query 136 * @param start the lower bound of the range of model instances 137 * @param end the upper bound of the range of model instances (not inclusive) 138 * @return the range of matching rows 139 */ 140 public <T> java.util.List<T> dynamicQuery( 141 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 142 int end); 143 144 /** 145 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 146 * 147 * <p> 148 * 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.PhoneModelImpl}. 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. 149 * </p> 150 * 151 * @param dynamicQuery the dynamic query 152 * @param start the lower bound of the range of model instances 153 * @param end the upper bound of the range of model instances (not inclusive) 154 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 155 * @return the ordered range of matching rows 156 */ 157 public <T> java.util.List<T> dynamicQuery( 158 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 159 int end, 160 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 161 162 /** 163 * Returns the number of rows matching the dynamic query. 164 * 165 * @param dynamicQuery the dynamic query 166 * @return the number of rows matching the dynamic query 167 */ 168 public long dynamicQueryCount( 169 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 170 171 /** 172 * Returns the number of rows matching the dynamic query. 173 * 174 * @param dynamicQuery the dynamic query 175 * @param projection the projection to apply to the query 176 * @return the number of rows matching the dynamic query 177 */ 178 public long dynamicQueryCount( 179 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 180 com.liferay.portal.kernel.dao.orm.Projection projection); 181 182 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 183 public com.liferay.portal.model.Phone fetchPhone(long phoneId); 184 185 /** 186 * Returns the phone with the matching UUID and company. 187 * 188 * @param uuid the phone's UUID 189 * @param companyId the primary key of the company 190 * @return the matching phone, or <code>null</code> if a matching phone could not be found 191 */ 192 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 193 public com.liferay.portal.model.Phone fetchPhoneByUuidAndCompanyId( 194 java.lang.String uuid, long companyId); 195 196 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 197 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 198 199 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 200 public com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery( 201 com.liferay.portlet.exportimport.lar.PortletDataContext portletDataContext); 202 203 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 204 public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery(); 205 206 /** 207 * Returns the OSGi service identifier. 208 * 209 * @return the OSGi service identifier 210 */ 211 public java.lang.String getOSGiServiceIdentifier(); 212 213 @Override 214 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 215 public com.liferay.portal.model.PersistedModel getPersistedModel( 216 java.io.Serializable primaryKeyObj) throws PortalException; 217 218 /** 219 * Returns the phone with the primary key. 220 * 221 * @param phoneId the primary key of the phone 222 * @return the phone 223 * @throws PortalException if a phone with the primary key could not be found 224 */ 225 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 226 public com.liferay.portal.model.Phone getPhone(long phoneId) 227 throws PortalException; 228 229 /** 230 * Returns the phone with the matching UUID and company. 231 * 232 * @param uuid the phone's UUID 233 * @param companyId the primary key of the company 234 * @return the matching phone 235 * @throws PortalException if a matching phone could not be found 236 */ 237 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 238 public com.liferay.portal.model.Phone getPhoneByUuidAndCompanyId( 239 java.lang.String uuid, long companyId) throws PortalException; 240 241 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 242 public java.util.List<com.liferay.portal.model.Phone> getPhones(); 243 244 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 245 public java.util.List<com.liferay.portal.model.Phone> getPhones( 246 long companyId, java.lang.String className, long classPK); 247 248 /** 249 * Returns a range of all the phones. 250 * 251 * <p> 252 * 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.PhoneModelImpl}. 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. 253 * </p> 254 * 255 * @param start the lower bound of the range of phones 256 * @param end the upper bound of the range of phones (not inclusive) 257 * @return the range of phones 258 */ 259 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 260 public java.util.List<com.liferay.portal.model.Phone> getPhones(int start, 261 int end); 262 263 /** 264 * Returns the number of phones. 265 * 266 * @return the number of phones 267 */ 268 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 269 public int getPhonesCount(); 270 271 /** 272 * Updates the phone in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 273 * 274 * @param phone the phone 275 * @return the phone that was updated 276 */ 277 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 278 public com.liferay.portal.model.Phone updatePhone( 279 com.liferay.portal.model.Phone phone); 280 281 public com.liferay.portal.model.Phone updatePhone(long phoneId, 282 java.lang.String number, java.lang.String extension, long typeId, 283 boolean primary) throws PortalException; 284 }