001 /** 002 * Copyright (c) 2000-2013 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 026 /** 027 * Provides the local service interface for Contact. Methods of this 028 * service will not have security checks based on the propagated JAAS 029 * credentials because this service can only be accessed from within the same 030 * VM. 031 * 032 * @author Brian Wing Shun Chan 033 * @see ContactLocalServiceUtil 034 * @see com.liferay.portal.service.base.ContactLocalServiceBaseImpl 035 * @see com.liferay.portal.service.impl.ContactLocalServiceImpl 036 * @generated 037 */ 038 @ProviderType 039 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 040 PortalException.class, SystemException.class}) 041 public interface ContactLocalService extends BaseLocalService, 042 PersistedModelLocalService { 043 /* 044 * NOTE FOR DEVELOPERS: 045 * 046 * Never modify or reference this interface directly. Always use {@link ContactLocalServiceUtil} to access the contact local service. Add custom service methods to {@link com.liferay.portal.service.impl.ContactLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 047 */ 048 049 /** 050 * Adds the contact to the database. Also notifies the appropriate model listeners. 051 * 052 * @param contact the contact 053 * @return the contact that was added 054 * @throws SystemException if a system exception occurred 055 */ 056 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 057 public com.liferay.portal.model.Contact addContact( 058 com.liferay.portal.model.Contact contact) 059 throws com.liferay.portal.kernel.exception.SystemException; 060 061 /** 062 * Creates a new contact with the primary key. Does not add the contact to the database. 063 * 064 * @param contactId the primary key for the new contact 065 * @return the new contact 066 */ 067 public com.liferay.portal.model.Contact createContact(long contactId); 068 069 /** 070 * Deletes the contact with the primary key from the database. Also notifies the appropriate model listeners. 071 * 072 * @param contactId the primary key of the contact 073 * @return the contact that was removed 074 * @throws PortalException if a contact with the primary key could not be found 075 * @throws SystemException if a system exception occurred 076 */ 077 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 078 public com.liferay.portal.model.Contact deleteContact(long contactId) 079 throws com.liferay.portal.kernel.exception.PortalException, 080 com.liferay.portal.kernel.exception.SystemException; 081 082 /** 083 * Deletes the contact from the database. Also notifies the appropriate model listeners. 084 * 085 * @param contact the contact 086 * @return the contact that was removed 087 * @throws SystemException if a system exception occurred 088 */ 089 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 090 public com.liferay.portal.model.Contact deleteContact( 091 com.liferay.portal.model.Contact contact) 092 throws com.liferay.portal.kernel.exception.SystemException; 093 094 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 095 096 /** 097 * Performs a dynamic query on the database and returns the matching rows. 098 * 099 * @param dynamicQuery the dynamic query 100 * @return the matching rows 101 * @throws SystemException if a system exception occurred 102 */ 103 @SuppressWarnings("rawtypes") 104 public java.util.List dynamicQuery( 105 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 106 throws com.liferay.portal.kernel.exception.SystemException; 107 108 /** 109 * Performs a dynamic query on the database and returns a range of the matching rows. 110 * 111 * <p> 112 * 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.ContactModelImpl}. 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. 113 * </p> 114 * 115 * @param dynamicQuery the dynamic query 116 * @param start the lower bound of the range of model instances 117 * @param end the upper bound of the range of model instances (not inclusive) 118 * @return the range of matching rows 119 * @throws SystemException if a system exception occurred 120 */ 121 @SuppressWarnings("rawtypes") 122 public java.util.List dynamicQuery( 123 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 124 int end) throws com.liferay.portal.kernel.exception.SystemException; 125 126 /** 127 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 128 * 129 * <p> 130 * 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.ContactModelImpl}. 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. 131 * </p> 132 * 133 * @param dynamicQuery the dynamic query 134 * @param start the lower bound of the range of model instances 135 * @param end the upper bound of the range of model instances (not inclusive) 136 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 137 * @return the ordered range of matching rows 138 * @throws SystemException if a system exception occurred 139 */ 140 @SuppressWarnings("rawtypes") 141 public java.util.List dynamicQuery( 142 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 143 int end, 144 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 145 throws com.liferay.portal.kernel.exception.SystemException; 146 147 /** 148 * Returns the number of rows that match the dynamic query. 149 * 150 * @param dynamicQuery the dynamic query 151 * @return the number of rows that match the dynamic query 152 * @throws SystemException if a system exception occurred 153 */ 154 public long dynamicQueryCount( 155 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 156 throws com.liferay.portal.kernel.exception.SystemException; 157 158 /** 159 * Returns the number of rows that match the dynamic query. 160 * 161 * @param dynamicQuery the dynamic query 162 * @param projection the projection to apply to the query 163 * @return the number of rows that match the dynamic query 164 * @throws SystemException if a system exception occurred 165 */ 166 public long dynamicQueryCount( 167 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 168 com.liferay.portal.kernel.dao.orm.Projection projection) 169 throws com.liferay.portal.kernel.exception.SystemException; 170 171 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 172 public com.liferay.portal.model.Contact fetchContact(long contactId) 173 throws com.liferay.portal.kernel.exception.SystemException; 174 175 /** 176 * Returns the contact with the primary key. 177 * 178 * @param contactId the primary key of the contact 179 * @return the contact 180 * @throws PortalException if a contact with the primary key could not be found 181 * @throws SystemException if a system exception occurred 182 */ 183 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 184 public com.liferay.portal.model.Contact getContact(long contactId) 185 throws com.liferay.portal.kernel.exception.PortalException, 186 com.liferay.portal.kernel.exception.SystemException; 187 188 @Override 189 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 190 public com.liferay.portal.model.PersistedModel getPersistedModel( 191 java.io.Serializable primaryKeyObj) 192 throws com.liferay.portal.kernel.exception.PortalException, 193 com.liferay.portal.kernel.exception.SystemException; 194 195 /** 196 * Returns a range of all the contacts. 197 * 198 * <p> 199 * 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.ContactModelImpl}. 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. 200 * </p> 201 * 202 * @param start the lower bound of the range of contacts 203 * @param end the upper bound of the range of contacts (not inclusive) 204 * @return the range of contacts 205 * @throws SystemException if a system exception occurred 206 */ 207 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 208 public java.util.List<com.liferay.portal.model.Contact> getContacts( 209 int start, int end) 210 throws com.liferay.portal.kernel.exception.SystemException; 211 212 /** 213 * Returns the number of contacts. 214 * 215 * @return the number of contacts 216 * @throws SystemException if a system exception occurred 217 */ 218 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 219 public int getContactsCount() 220 throws com.liferay.portal.kernel.exception.SystemException; 221 222 /** 223 * Updates the contact in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 224 * 225 * @param contact the contact 226 * @return the contact that was updated 227 * @throws SystemException if a system exception occurred 228 */ 229 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 230 public com.liferay.portal.model.Contact updateContact( 231 com.liferay.portal.model.Contact contact) 232 throws com.liferay.portal.kernel.exception.SystemException; 233 234 /** 235 * Returns the Spring bean ID for this bean. 236 * 237 * @return the Spring bean ID for this bean 238 */ 239 public java.lang.String getBeanIdentifier(); 240 241 /** 242 * Sets the Spring bean ID for this bean. 243 * 244 * @param beanIdentifier the Spring bean ID for this bean 245 */ 246 public void setBeanIdentifier(java.lang.String beanIdentifier); 247 248 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 249 public com.liferay.portal.model.Contact addContact(long userId, 250 java.lang.String className, long classPK, 251 java.lang.String emailAddress, java.lang.String firstName, 252 java.lang.String middleName, java.lang.String lastName, int prefixId, 253 int suffixId, boolean male, int birthdayMonth, int birthdayDay, 254 int birthdayYear, java.lang.String smsSn, java.lang.String aimSn, 255 java.lang.String facebookSn, java.lang.String icqSn, 256 java.lang.String jabberSn, java.lang.String msnSn, 257 java.lang.String mySpaceSn, java.lang.String skypeSn, 258 java.lang.String twitterSn, java.lang.String ymSn, 259 java.lang.String jobTitle) 260 throws com.liferay.portal.kernel.exception.PortalException, 261 com.liferay.portal.kernel.exception.SystemException; 262 263 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 264 public java.util.List<com.liferay.portal.model.Contact> getContacts( 265 long classNameId, long classPK, int start, int end, 266 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 267 throws com.liferay.portal.kernel.exception.SystemException; 268 269 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 270 public int getContactsCount(long classNameId, long classPK) 271 throws com.liferay.portal.kernel.exception.SystemException; 272 273 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 274 public com.liferay.portal.model.Contact updateContact(long contactId, 275 java.lang.String emailAddress, java.lang.String firstName, 276 java.lang.String middleName, java.lang.String lastName, int prefixId, 277 int suffixId, boolean male, int birthdayMonth, int birthdayDay, 278 int birthdayYear, java.lang.String smsSn, java.lang.String aimSn, 279 java.lang.String facebookSn, java.lang.String icqSn, 280 java.lang.String jabberSn, java.lang.String msnSn, 281 java.lang.String mySpaceSn, java.lang.String skypeSn, 282 java.lang.String twitterSn, java.lang.String ymSn, 283 java.lang.String jobTitle) 284 throws com.liferay.portal.kernel.exception.PortalException, 285 com.liferay.portal.kernel.exception.SystemException; 286 }