001    /**
002     * Copyright (c) 2000-2012 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            * <p>
150            * 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.
151            * </p>
152            *
153            * @param companyId the company ID
154            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
155            * @return the first matching contact
156            * @throws com.liferay.portal.NoSuchContactException if a matching contact could not be found
157            * @throws SystemException if a system exception occurred
158            */
159            public com.liferay.portal.model.Contact findByCompanyId_First(
160                    long companyId,
161                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
162                    throws com.liferay.portal.NoSuchContactException,
163                            com.liferay.portal.kernel.exception.SystemException;
164    
165            /**
166            * Returns the last contact in the ordered set where companyId = &#63;.
167            *
168            * <p>
169            * 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.
170            * </p>
171            *
172            * @param companyId the company ID
173            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
174            * @return the last matching contact
175            * @throws com.liferay.portal.NoSuchContactException if a matching contact could not be found
176            * @throws SystemException if a system exception occurred
177            */
178            public com.liferay.portal.model.Contact findByCompanyId_Last(
179                    long companyId,
180                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
181                    throws com.liferay.portal.NoSuchContactException,
182                            com.liferay.portal.kernel.exception.SystemException;
183    
184            /**
185            * Returns the contacts before and after the current contact in the ordered set where companyId = &#63;.
186            *
187            * <p>
188            * 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.
189            * </p>
190            *
191            * @param contactId the primary key of the current contact
192            * @param companyId the company ID
193            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
194            * @return the previous, current, and next contact
195            * @throws com.liferay.portal.NoSuchContactException if a contact with the primary key could not be found
196            * @throws SystemException if a system exception occurred
197            */
198            public com.liferay.portal.model.Contact[] findByCompanyId_PrevAndNext(
199                    long contactId, long companyId,
200                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
201                    throws com.liferay.portal.NoSuchContactException,
202                            com.liferay.portal.kernel.exception.SystemException;
203    
204            /**
205            * Returns all the contacts.
206            *
207            * @return the contacts
208            * @throws SystemException if a system exception occurred
209            */
210            public java.util.List<com.liferay.portal.model.Contact> findAll()
211                    throws com.liferay.portal.kernel.exception.SystemException;
212    
213            /**
214            * Returns a range of all the contacts.
215            *
216            * <p>
217            * 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.
218            * </p>
219            *
220            * @param start the lower bound of the range of contacts
221            * @param end the upper bound of the range of contacts (not inclusive)
222            * @return the range of contacts
223            * @throws SystemException if a system exception occurred
224            */
225            public java.util.List<com.liferay.portal.model.Contact> findAll(int start,
226                    int end) throws com.liferay.portal.kernel.exception.SystemException;
227    
228            /**
229            * Returns an ordered range of all the contacts.
230            *
231            * <p>
232            * 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.
233            * </p>
234            *
235            * @param start the lower bound of the range of contacts
236            * @param end the upper bound of the range of contacts (not inclusive)
237            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
238            * @return the ordered range of contacts
239            * @throws SystemException if a system exception occurred
240            */
241            public java.util.List<com.liferay.portal.model.Contact> findAll(int start,
242                    int end,
243                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
244                    throws com.liferay.portal.kernel.exception.SystemException;
245    
246            /**
247            * Removes all the contacts where companyId = &#63; from the database.
248            *
249            * @param companyId the company ID
250            * @throws SystemException if a system exception occurred
251            */
252            public void removeByCompanyId(long companyId)
253                    throws com.liferay.portal.kernel.exception.SystemException;
254    
255            /**
256            * Removes all the contacts from the database.
257            *
258            * @throws SystemException if a system exception occurred
259            */
260            public void removeAll()
261                    throws com.liferay.portal.kernel.exception.SystemException;
262    
263            /**
264            * Returns the number of contacts where companyId = &#63;.
265            *
266            * @param companyId the company ID
267            * @return the number of matching contacts
268            * @throws SystemException if a system exception occurred
269            */
270            public int countByCompanyId(long companyId)
271                    throws com.liferay.portal.kernel.exception.SystemException;
272    
273            /**
274            * Returns the number of contacts.
275            *
276            * @return the number of contacts
277            * @throws SystemException if a system exception occurred
278            */
279            public int countAll()
280                    throws com.liferay.portal.kernel.exception.SystemException;
281    }