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