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