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