001 /** 002 * Copyright (c) 2000-2012 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 com.liferay.portal.kernel.exception.PortalException; 018 import com.liferay.portal.kernel.exception.SystemException; 019 import com.liferay.portal.kernel.transaction.Isolation; 020 import com.liferay.portal.kernel.transaction.Propagation; 021 import com.liferay.portal.kernel.transaction.Transactional; 022 023 /** 024 * The interface for the phone local service. 025 * 026 * <p> 027 * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM. 028 * </p> 029 * 030 * @author Brian Wing Shun Chan 031 * @see PhoneLocalServiceUtil 032 * @see com.liferay.portal.service.base.PhoneLocalServiceBaseImpl 033 * @see com.liferay.portal.service.impl.PhoneLocalServiceImpl 034 * @generated 035 */ 036 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 037 PortalException.class, SystemException.class}) 038 public interface PhoneLocalService extends PersistedModelLocalService { 039 /* 040 * NOTE FOR DEVELOPERS: 041 * 042 * 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. 043 */ 044 045 /** 046 * Adds the phone to the database. Also notifies the appropriate model listeners. 047 * 048 * @param phone the phone 049 * @return the phone that was added 050 * @throws SystemException if a system exception occurred 051 */ 052 public com.liferay.portal.model.Phone addPhone( 053 com.liferay.portal.model.Phone phone) 054 throws com.liferay.portal.kernel.exception.SystemException; 055 056 /** 057 * Creates a new phone with the primary key. Does not add the phone to the database. 058 * 059 * @param phoneId the primary key for the new phone 060 * @return the new phone 061 */ 062 public com.liferay.portal.model.Phone createPhone(long phoneId); 063 064 /** 065 * Deletes the phone with the primary key from the database. Also notifies the appropriate model listeners. 066 * 067 * @param phoneId the primary key of the phone 068 * @throws PortalException if a phone with the primary key could not be found 069 * @throws SystemException if a system exception occurred 070 */ 071 public void deletePhone(long phoneId) 072 throws com.liferay.portal.kernel.exception.PortalException, 073 com.liferay.portal.kernel.exception.SystemException; 074 075 /** 076 * Deletes the phone from the database. Also notifies the appropriate model listeners. 077 * 078 * @param phone the phone 079 * @throws SystemException if a system exception occurred 080 */ 081 public void deletePhone(com.liferay.portal.model.Phone phone) 082 throws com.liferay.portal.kernel.exception.SystemException; 083 084 /** 085 * Performs a dynamic query on the database and returns the matching rows. 086 * 087 * @param dynamicQuery the dynamic query 088 * @return the matching rows 089 * @throws SystemException if a system exception occurred 090 */ 091 @SuppressWarnings("rawtypes") 092 public java.util.List dynamicQuery( 093 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 094 throws com.liferay.portal.kernel.exception.SystemException; 095 096 /** 097 * Performs a dynamic query on the database and returns a range of the matching rows. 098 * 099 * <p> 100 * 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. 101 * </p> 102 * 103 * @param dynamicQuery the dynamic query 104 * @param start the lower bound of the range of model instances 105 * @param end the upper bound of the range of model instances (not inclusive) 106 * @return the range of matching rows 107 * @throws SystemException if a system exception occurred 108 */ 109 @SuppressWarnings("rawtypes") 110 public java.util.List dynamicQuery( 111 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 112 int end) throws com.liferay.portal.kernel.exception.SystemException; 113 114 /** 115 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 116 * 117 * <p> 118 * 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. 119 * </p> 120 * 121 * @param dynamicQuery the dynamic query 122 * @param start the lower bound of the range of model instances 123 * @param end the upper bound of the range of model instances (not inclusive) 124 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 125 * @return the ordered range of matching rows 126 * @throws SystemException if a system exception occurred 127 */ 128 @SuppressWarnings("rawtypes") 129 public java.util.List dynamicQuery( 130 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 131 int end, 132 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 133 throws com.liferay.portal.kernel.exception.SystemException; 134 135 /** 136 * Returns the number of rows that match the dynamic query. 137 * 138 * @param dynamicQuery the dynamic query 139 * @return the number of rows that match the dynamic query 140 * @throws SystemException if a system exception occurred 141 */ 142 public long dynamicQueryCount( 143 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 144 throws com.liferay.portal.kernel.exception.SystemException; 145 146 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 147 public com.liferay.portal.model.Phone fetchPhone(long phoneId) 148 throws com.liferay.portal.kernel.exception.SystemException; 149 150 /** 151 * Returns the phone with the primary key. 152 * 153 * @param phoneId the primary key of the phone 154 * @return the phone 155 * @throws PortalException if a phone with the primary key could not be found 156 * @throws SystemException if a system exception occurred 157 */ 158 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 159 public com.liferay.portal.model.Phone getPhone(long phoneId) 160 throws com.liferay.portal.kernel.exception.PortalException, 161 com.liferay.portal.kernel.exception.SystemException; 162 163 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 164 public com.liferay.portal.model.PersistedModel getPersistedModel( 165 java.io.Serializable primaryKeyObj) 166 throws com.liferay.portal.kernel.exception.PortalException, 167 com.liferay.portal.kernel.exception.SystemException; 168 169 /** 170 * Returns a range of all the phones. 171 * 172 * <p> 173 * 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. 174 * </p> 175 * 176 * @param start the lower bound of the range of phones 177 * @param end the upper bound of the range of phones (not inclusive) 178 * @return the range of phones 179 * @throws SystemException if a system exception occurred 180 */ 181 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 182 public java.util.List<com.liferay.portal.model.Phone> getPhones(int start, 183 int end) throws com.liferay.portal.kernel.exception.SystemException; 184 185 /** 186 * Returns the number of phones. 187 * 188 * @return the number of phones 189 * @throws SystemException if a system exception occurred 190 */ 191 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 192 public int getPhonesCount() 193 throws com.liferay.portal.kernel.exception.SystemException; 194 195 /** 196 * Updates the phone in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 197 * 198 * @param phone the phone 199 * @return the phone that was updated 200 * @throws SystemException if a system exception occurred 201 */ 202 public com.liferay.portal.model.Phone updatePhone( 203 com.liferay.portal.model.Phone phone) 204 throws com.liferay.portal.kernel.exception.SystemException; 205 206 /** 207 * Updates the phone in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 208 * 209 * @param phone the phone 210 * @param merge whether to merge the phone with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation. 211 * @return the phone that was updated 212 * @throws SystemException if a system exception occurred 213 */ 214 public com.liferay.portal.model.Phone updatePhone( 215 com.liferay.portal.model.Phone phone, boolean merge) 216 throws com.liferay.portal.kernel.exception.SystemException; 217 218 /** 219 * Returns the Spring bean ID for this bean. 220 * 221 * @return the Spring bean ID for this bean 222 */ 223 public java.lang.String getBeanIdentifier(); 224 225 /** 226 * Sets the Spring bean ID for this bean. 227 * 228 * @param beanIdentifier the Spring bean ID for this bean 229 */ 230 public void setBeanIdentifier(java.lang.String beanIdentifier); 231 232 public com.liferay.portal.model.Phone addPhone(long userId, 233 java.lang.String className, long classPK, java.lang.String number, 234 java.lang.String extension, int typeId, boolean primary) 235 throws com.liferay.portal.kernel.exception.PortalException, 236 com.liferay.portal.kernel.exception.SystemException; 237 238 public void deletePhones(long companyId, java.lang.String className, 239 long classPK) 240 throws com.liferay.portal.kernel.exception.SystemException; 241 242 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 243 public java.util.List<com.liferay.portal.model.Phone> getPhones() 244 throws com.liferay.portal.kernel.exception.SystemException; 245 246 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 247 public java.util.List<com.liferay.portal.model.Phone> getPhones( 248 long companyId, java.lang.String className, long classPK) 249 throws com.liferay.portal.kernel.exception.SystemException; 250 251 public com.liferay.portal.model.Phone updatePhone(long phoneId, 252 java.lang.String number, java.lang.String extension, int typeId, 253 boolean primary) 254 throws com.liferay.portal.kernel.exception.PortalException, 255 com.liferay.portal.kernel.exception.SystemException; 256 }