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