001    /**
002     * Copyright (c) 2000-2013 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.persistence;
016    
017    import com.liferay.portal.model.Contact;
018    
019    /**
020     * The persistence interface for the contact service.
021     *
022     * <p>
023     * Caching information and settings can be found in <code>portal.properties</code>
024     * </p>
025     *
026     * @author Brian Wing Shun Chan
027     * @see ContactPersistenceImpl
028     * @see ContactUtil
029     * @generated
030     */
031    public interface ContactPersistence extends BasePersistence<Contact> {
032            /*
033             * NOTE FOR DEVELOPERS:
034             *
035             * Never modify or reference this interface directly. Always use {@link ContactUtil} to access the contact persistence. Modify <code>service.xml</code> and rerun ServiceBuilder to regenerate this interface.
036             */
037    
038            /**
039            * Caches the contact in the entity cache if it is enabled.
040            *
041            * @param contact the contact
042            */
043            public void cacheResult(com.liferay.portal.model.Contact contact);
044    
045            /**
046            * Caches the contacts in the entity cache if it is enabled.
047            *
048            * @param contacts the contacts
049            */
050            public void cacheResult(
051                    java.util.List<com.liferay.portal.model.Contact> contacts);
052    
053            /**
054            * Creates a new contact with the primary key. Does not add the contact to the database.
055            *
056            * @param contactId the primary key for the new contact
057            * @return the new contact
058            */
059            public com.liferay.portal.model.Contact create(long contactId);
060    
061            /**
062            * Removes the contact with the primary key from the database. Also notifies the appropriate model listeners.
063            *
064            * @param contactId the primary key of the contact
065            * @return the contact that was removed
066            * @throws com.liferay.portal.NoSuchContactException if a contact with the primary key could not be found
067            * @throws SystemException if a system exception occurred
068            */
069            public com.liferay.portal.model.Contact remove(long contactId)
070                    throws com.liferay.portal.NoSuchContactException,
071                            com.liferay.portal.kernel.exception.SystemException;
072    
073            public com.liferay.portal.model.Contact updateImpl(
074                    com.liferay.portal.model.Contact contact, boolean merge)
075                    throws com.liferay.portal.kernel.exception.SystemException;
076    
077            /**
078            * Returns the contact with the primary key or throws a {@link com.liferay.portal.NoSuchContactException} if it could not be found.
079            *
080            * @param contactId the primary key of the contact
081            * @return the contact
082            * @throws com.liferay.portal.NoSuchContactException if a contact with the primary key could not be found
083            * @throws SystemException if a system exception occurred
084            */
085            public com.liferay.portal.model.Contact findByPrimaryKey(long contactId)
086                    throws com.liferay.portal.NoSuchContactException,
087                            com.liferay.portal.kernel.exception.SystemException;
088    
089            /**
090            * Returns the contact with the primary key or returns <code>null</code> if it could not be found.
091            *
092            * @param contactId the primary key of the contact
093            * @return the contact, or <code>null</code> if a contact with the primary key could not be found
094            * @throws SystemException if a system exception occurred
095            */
096            public com.liferay.portal.model.Contact fetchByPrimaryKey(long contactId)
097                    throws com.liferay.portal.kernel.exception.SystemException;
098    
099            /**
100            * Returns all the contacts where companyId = &#63;.
101            *
102            * @param companyId the company ID
103            * @return the matching contacts
104            * @throws SystemException if a system exception occurred
105            */
106            public java.util.List<com.liferay.portal.model.Contact> findByCompanyId(
107                    long companyId)
108                    throws com.liferay.portal.kernel.exception.SystemException;
109    
110            /**
111            * Returns a range of all the contacts where companyId = &#63;.
112            *
113            * <p>
114            * 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.
115            * </p>
116            *
117            * @param companyId the company ID
118            * @param start the lower bound of the range of contacts
119            * @param end the upper bound of the range of contacts (not inclusive)
120            * @return the range of matching contacts
121            * @throws SystemException if a system exception occurred
122            */
123            public java.util.List<com.liferay.portal.model.Contact> findByCompanyId(
124                    long companyId, int start, int end)
125                    throws com.liferay.portal.kernel.exception.SystemException;
126    
127            /**
128            * Returns an ordered range of all the contacts where companyId = &#63;.
129            *
130            * <p>
131            * 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.
132            * </p>
133            *
134            * @param companyId the company ID
135            * @param start the lower bound of the range of contacts
136            * @param end the upper bound of the range of contacts (not inclusive)
137            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
138            * @return the ordered range of matching contacts
139            * @throws SystemException if a system exception occurred
140            */
141            public java.util.List<com.liferay.portal.model.Contact> findByCompanyId(
142                    long companyId, int start, int end,
143                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
144                    throws com.liferay.portal.kernel.exception.SystemException;
145    
146            /**
147            * Returns the first contact in the ordered set where companyId = &#63;.
148            *
149            * @param companyId the company ID
150            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
151            * @return the first matching contact
152            * @throws com.liferay.portal.NoSuchContactException if a matching contact could not be found
153            * @throws SystemException if a system exception occurred
154            */
155            public com.liferay.portal.model.Contact findByCompanyId_First(
156                    long companyId,
157                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
158                    throws com.liferay.portal.NoSuchContactException,
159                            com.liferay.portal.kernel.exception.SystemException;
160    
161            /**
162            * Returns the first contact in the ordered set where companyId = &#63;.
163            *
164            * @param companyId the company ID
165            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
166            * @return the first matching contact, or <code>null</code> if a matching contact could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            public com.liferay.portal.model.Contact fetchByCompanyId_First(
170                    long companyId,
171                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
172                    throws com.liferay.portal.kernel.exception.SystemException;
173    
174            /**
175            * Returns the last contact in the ordered set where companyId = &#63;.
176            *
177            * @param companyId the company ID
178            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
179            * @return the last matching contact
180            * @throws com.liferay.portal.NoSuchContactException if a matching contact could not be found
181            * @throws SystemException if a system exception occurred
182            */
183            public com.liferay.portal.model.Contact findByCompanyId_Last(
184                    long companyId,
185                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
186                    throws com.liferay.portal.NoSuchContactException,
187                            com.liferay.portal.kernel.exception.SystemException;
188    
189            /**
190            * Returns the last contact in the ordered set where companyId = &#63;.
191            *
192            * @param companyId the company ID
193            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
194            * @return the last matching contact, or <code>null</code> if a matching contact could not be found
195            * @throws SystemException if a system exception occurred
196            */
197            public com.liferay.portal.model.Contact fetchByCompanyId_Last(
198                    long companyId,
199                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
200                    throws com.liferay.portal.kernel.exception.SystemException;
201    
202            /**
203            * Returns the contacts before and after the current contact in the ordered set where companyId = &#63;.
204            *
205            * @param contactId the primary key of the current contact
206            * @param companyId the company ID
207            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
208            * @return the previous, current, and next contact
209            * @throws com.liferay.portal.NoSuchContactException if a contact with the primary key could not be found
210            * @throws SystemException if a system exception occurred
211            */
212            public com.liferay.portal.model.Contact[] findByCompanyId_PrevAndNext(
213                    long contactId, long companyId,
214                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
215                    throws com.liferay.portal.NoSuchContactException,
216                            com.liferay.portal.kernel.exception.SystemException;
217    
218            /**
219            * Returns all the contacts.
220            *
221            * @return the contacts
222            * @throws SystemException if a system exception occurred
223            */
224            public java.util.List<com.liferay.portal.model.Contact> findAll()
225                    throws com.liferay.portal.kernel.exception.SystemException;
226    
227            /**
228            * Returns a range of all the contacts.
229            *
230            * <p>
231            * 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.
232            * </p>
233            *
234            * @param start the lower bound of the range of contacts
235            * @param end the upper bound of the range of contacts (not inclusive)
236            * @return the range of contacts
237            * @throws SystemException if a system exception occurred
238            */
239            public java.util.List<com.liferay.portal.model.Contact> findAll(int start,
240                    int end) throws com.liferay.portal.kernel.exception.SystemException;
241    
242            /**
243            * Returns an ordered range of all the contacts.
244            *
245            * <p>
246            * 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.
247            * </p>
248            *
249            * @param start the lower bound of the range of contacts
250            * @param end the upper bound of the range of contacts (not inclusive)
251            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
252            * @return the ordered range of contacts
253            * @throws SystemException if a system exception occurred
254            */
255            public java.util.List<com.liferay.portal.model.Contact> findAll(int start,
256                    int end,
257                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
258                    throws com.liferay.portal.kernel.exception.SystemException;
259    
260            /**
261            * Removes all the contacts where companyId = &#63; from the database.
262            *
263            * @param companyId the company ID
264            * @throws SystemException if a system exception occurred
265            */
266            public void removeByCompanyId(long companyId)
267                    throws com.liferay.portal.kernel.exception.SystemException;
268    
269            /**
270            * Removes all the contacts from the database.
271            *
272            * @throws SystemException if a system exception occurred
273            */
274            public void removeAll()
275                    throws com.liferay.portal.kernel.exception.SystemException;
276    
277            /**
278            * Returns the number of contacts where companyId = &#63;.
279            *
280            * @param companyId the company ID
281            * @return the number of matching contacts
282            * @throws SystemException if a system exception occurred
283            */
284            public int countByCompanyId(long companyId)
285                    throws com.liferay.portal.kernel.exception.SystemException;
286    
287            /**
288            * Returns the number of contacts.
289            *
290            * @return the number of contacts
291            * @throws SystemException if a system exception occurred
292            */
293            public int countAll()
294                    throws com.liferay.portal.kernel.exception.SystemException;
295    }