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 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 */ 055 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 056 public com.liferay.portal.model.Contact addContact( 057 com.liferay.portal.model.Contact contact); 058 059 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 060 public com.liferay.portal.model.Contact addContact(long userId, 061 java.lang.String className, long classPK, 062 java.lang.String emailAddress, java.lang.String firstName, 063 java.lang.String middleName, java.lang.String lastName, int prefixId, 064 int suffixId, boolean male, int birthdayMonth, int birthdayDay, 065 int birthdayYear, java.lang.String smsSn, java.lang.String aimSn, 066 java.lang.String facebookSn, java.lang.String icqSn, 067 java.lang.String jabberSn, java.lang.String msnSn, 068 java.lang.String mySpaceSn, java.lang.String skypeSn, 069 java.lang.String twitterSn, java.lang.String ymSn, 070 java.lang.String jobTitle) 071 throws com.liferay.portal.kernel.exception.PortalException; 072 073 /** 074 * Creates a new contact with the primary key. Does not add the contact to the database. 075 * 076 * @param contactId the primary key for the new contact 077 * @return the new contact 078 */ 079 public com.liferay.portal.model.Contact createContact(long contactId); 080 081 /** 082 * Deletes the contact from the database. Also notifies the appropriate model listeners. 083 * 084 * @param contact the contact 085 * @return the contact that was removed 086 */ 087 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 088 public com.liferay.portal.model.Contact deleteContact( 089 com.liferay.portal.model.Contact contact); 090 091 /** 092 * Deletes the contact with the primary key from the database. Also notifies the appropriate model listeners. 093 * 094 * @param contactId the primary key of the contact 095 * @return the contact that was removed 096 * @throws PortalException if a contact with the primary key could not be found 097 */ 098 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 099 public com.liferay.portal.model.Contact deleteContact(long contactId) 100 throws com.liferay.portal.kernel.exception.PortalException; 101 102 /** 103 * @throws PortalException 104 */ 105 @Override 106 public com.liferay.portal.model.PersistedModel deletePersistedModel( 107 com.liferay.portal.model.PersistedModel persistedModel) 108 throws com.liferay.portal.kernel.exception.PortalException; 109 110 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 111 112 /** 113 * Performs a dynamic query on the database and returns the matching rows. 114 * 115 * @param dynamicQuery the dynamic query 116 * @return the matching rows 117 */ 118 public <T> java.util.List<T> dynamicQuery( 119 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 120 121 /** 122 * Performs a dynamic query on the database and returns a range of the matching rows. 123 * 124 * <p> 125 * 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. 126 * </p> 127 * 128 * @param dynamicQuery the dynamic query 129 * @param start the lower bound of the range of model instances 130 * @param end the upper bound of the range of model instances (not inclusive) 131 * @return the range of matching rows 132 */ 133 public <T> java.util.List<T> dynamicQuery( 134 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 135 int end); 136 137 /** 138 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 139 * 140 * <p> 141 * 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. 142 * </p> 143 * 144 * @param dynamicQuery the dynamic query 145 * @param start the lower bound of the range of model instances 146 * @param end the upper bound of the range of model instances (not inclusive) 147 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 148 * @return the ordered range of matching rows 149 */ 150 public <T> java.util.List<T> dynamicQuery( 151 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 152 int end, 153 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 154 155 /** 156 * Returns the number of rows matching the dynamic query. 157 * 158 * @param dynamicQuery the dynamic query 159 * @return the number of rows matching the dynamic query 160 */ 161 public long dynamicQueryCount( 162 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 163 164 /** 165 * Returns the number of rows matching the dynamic query. 166 * 167 * @param dynamicQuery the dynamic query 168 * @param projection the projection to apply to the query 169 * @return the number of rows matching the dynamic query 170 */ 171 public long dynamicQueryCount( 172 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 173 com.liferay.portal.kernel.dao.orm.Projection projection); 174 175 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 176 public com.liferay.portal.model.Contact fetchContact(long contactId); 177 178 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 179 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 180 181 /** 182 * Returns the Spring bean ID for this bean. 183 * 184 * @return the Spring bean ID for this bean 185 */ 186 public java.lang.String getBeanIdentifier(); 187 188 /** 189 * Returns the contact with the primary key. 190 * 191 * @param contactId the primary key of the contact 192 * @return the contact 193 * @throws PortalException if a contact with the primary key could not be found 194 */ 195 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 196 public com.liferay.portal.model.Contact getContact(long contactId) 197 throws com.liferay.portal.kernel.exception.PortalException; 198 199 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 200 public java.util.List<com.liferay.portal.model.Contact> getContacts( 201 long classNameId, long classPK, int start, int end, 202 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.Contact> orderByComparator); 203 204 /** 205 * Returns a range of all the contacts. 206 * 207 * <p> 208 * 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. 209 * </p> 210 * 211 * @param start the lower bound of the range of contacts 212 * @param end the upper bound of the range of contacts (not inclusive) 213 * @return the range of contacts 214 */ 215 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 216 public java.util.List<com.liferay.portal.model.Contact> getContacts( 217 int start, int end); 218 219 /** 220 * Returns the number of contacts. 221 * 222 * @return the number of contacts 223 */ 224 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 225 public int getContactsCount(); 226 227 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 228 public int getContactsCount(long classNameId, long classPK); 229 230 @Override 231 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 232 public com.liferay.portal.model.PersistedModel getPersistedModel( 233 java.io.Serializable primaryKeyObj) 234 throws com.liferay.portal.kernel.exception.PortalException; 235 236 /** 237 * Sets the Spring bean ID for this bean. 238 * 239 * @param beanIdentifier the Spring bean ID for this bean 240 */ 241 public void setBeanIdentifier(java.lang.String beanIdentifier); 242 243 /** 244 * Updates the contact in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 245 * 246 * @param contact the contact 247 * @return the contact that was updated 248 */ 249 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 250 public com.liferay.portal.model.Contact updateContact( 251 com.liferay.portal.model.Contact contact); 252 253 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 254 public com.liferay.portal.model.Contact updateContact(long contactId, 255 java.lang.String emailAddress, java.lang.String firstName, 256 java.lang.String middleName, java.lang.String lastName, int prefixId, 257 int suffixId, boolean male, int birthdayMonth, int birthdayDay, 258 int birthdayYear, java.lang.String smsSn, java.lang.String aimSn, 259 java.lang.String facebookSn, java.lang.String icqSn, 260 java.lang.String jabberSn, java.lang.String msnSn, 261 java.lang.String mySpaceSn, java.lang.String skypeSn, 262 java.lang.String twitterSn, java.lang.String ymSn, 263 java.lang.String jobTitle) 264 throws com.liferay.portal.kernel.exception.PortalException; 265 }