001    /**
002     * Copyright (c) 2000-2011 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.portlet.dynamicdatamapping.service.persistence;
016    
017    import com.liferay.portal.kernel.exception.SystemException;
018    import com.liferay.portal.service.persistence.BasePersistence;
019    
020    import com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink;
021    
022    /**
023     * The persistence interface for the d d m storage link service.
024     *
025     * <p>
026     * Caching information and settings can be found in <code>portal.properties</code>
027     * </p>
028     *
029     * @author Brian Wing Shun Chan
030     * @see DDMStorageLinkPersistenceImpl
031     * @see DDMStorageLinkUtil
032     * @generated
033     */
034    public interface DDMStorageLinkPersistence extends BasePersistence<DDMStorageLink> {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify or reference this interface directly. Always use {@link DDMStorageLinkUtil} to access the d d m storage link persistence. Modify <code>service.xml</code> and rerun ServiceBuilder to regenerate this interface.
039             */
040    
041            /**
042            * Caches the d d m storage link in the entity cache if it is enabled.
043            *
044            * @param ddmStorageLink the d d m storage link
045            */
046            public void cacheResult(
047                    com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink ddmStorageLink);
048    
049            /**
050            * Caches the d d m storage links in the entity cache if it is enabled.
051            *
052            * @param ddmStorageLinks the d d m storage links
053            */
054            public void cacheResult(
055                    java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink> ddmStorageLinks);
056    
057            /**
058            * Creates a new d d m storage link with the primary key. Does not add the d d m storage link to the database.
059            *
060            * @param storageLinkId the primary key for the new d d m storage link
061            * @return the new d d m storage link
062            */
063            public com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink create(
064                    long storageLinkId);
065    
066            /**
067            * Removes the d d m storage link with the primary key from the database. Also notifies the appropriate model listeners.
068            *
069            * @param storageLinkId the primary key of the d d m storage link
070            * @return the d d m storage link that was removed
071            * @throws com.liferay.portlet.dynamicdatamapping.NoSuchStorageLinkException if a d d m storage link with the primary key could not be found
072            * @throws SystemException if a system exception occurred
073            */
074            public com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink remove(
075                    long storageLinkId)
076                    throws com.liferay.portal.kernel.exception.SystemException,
077                            com.liferay.portlet.dynamicdatamapping.NoSuchStorageLinkException;
078    
079            public com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink updateImpl(
080                    com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink ddmStorageLink,
081                    boolean merge)
082                    throws com.liferay.portal.kernel.exception.SystemException;
083    
084            /**
085            * Returns the d d m storage link with the primary key or throws a {@link com.liferay.portlet.dynamicdatamapping.NoSuchStorageLinkException} if it could not be found.
086            *
087            * @param storageLinkId the primary key of the d d m storage link
088            * @return the d d m storage link
089            * @throws com.liferay.portlet.dynamicdatamapping.NoSuchStorageLinkException if a d d m storage link with the primary key could not be found
090            * @throws SystemException if a system exception occurred
091            */
092            public com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink findByPrimaryKey(
093                    long storageLinkId)
094                    throws com.liferay.portal.kernel.exception.SystemException,
095                            com.liferay.portlet.dynamicdatamapping.NoSuchStorageLinkException;
096    
097            /**
098            * Returns the d d m storage link with the primary key or returns <code>null</code> if it could not be found.
099            *
100            * @param storageLinkId the primary key of the d d m storage link
101            * @return the d d m storage link, or <code>null</code> if a d d m storage link with the primary key could not be found
102            * @throws SystemException if a system exception occurred
103            */
104            public com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink fetchByPrimaryKey(
105                    long storageLinkId)
106                    throws com.liferay.portal.kernel.exception.SystemException;
107    
108            /**
109            * Returns all the d d m storage links where uuid = &#63;.
110            *
111            * @param uuid the uuid
112            * @return the matching d d m storage links
113            * @throws SystemException if a system exception occurred
114            */
115            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink> findByUuid(
116                    java.lang.String uuid)
117                    throws com.liferay.portal.kernel.exception.SystemException;
118    
119            /**
120            * Returns a range of all the d d m storage links where uuid = &#63;.
121            *
122            * <p>
123            * 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.
124            * </p>
125            *
126            * @param uuid the uuid
127            * @param start the lower bound of the range of d d m storage links
128            * @param end the upper bound of the range of d d m storage links (not inclusive)
129            * @return the range of matching d d m storage links
130            * @throws SystemException if a system exception occurred
131            */
132            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink> findByUuid(
133                    java.lang.String uuid, int start, int end)
134                    throws com.liferay.portal.kernel.exception.SystemException;
135    
136            /**
137            * Returns an ordered range of all the d d m storage links where uuid = &#63;.
138            *
139            * <p>
140            * 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.
141            * </p>
142            *
143            * @param uuid the uuid
144            * @param start the lower bound of the range of d d m storage links
145            * @param end the upper bound of the range of d d m storage links (not inclusive)
146            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
147            * @return the ordered range of matching d d m storage links
148            * @throws SystemException if a system exception occurred
149            */
150            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink> findByUuid(
151                    java.lang.String uuid, int start, int end,
152                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
153                    throws com.liferay.portal.kernel.exception.SystemException;
154    
155            /**
156            * Returns the first d d m storage link in the ordered set where uuid = &#63;.
157            *
158            * <p>
159            * 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.
160            * </p>
161            *
162            * @param uuid the uuid
163            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
164            * @return the first matching d d m storage link
165            * @throws com.liferay.portlet.dynamicdatamapping.NoSuchStorageLinkException if a matching d d m storage link could not be found
166            * @throws SystemException if a system exception occurred
167            */
168            public com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink findByUuid_First(
169                    java.lang.String uuid,
170                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
171                    throws com.liferay.portal.kernel.exception.SystemException,
172                            com.liferay.portlet.dynamicdatamapping.NoSuchStorageLinkException;
173    
174            /**
175            * Returns the last d d m storage link in the ordered set where uuid = &#63;.
176            *
177            * <p>
178            * 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.
179            * </p>
180            *
181            * @param uuid the uuid
182            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
183            * @return the last matching d d m storage link
184            * @throws com.liferay.portlet.dynamicdatamapping.NoSuchStorageLinkException if a matching d d m storage link could not be found
185            * @throws SystemException if a system exception occurred
186            */
187            public com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink findByUuid_Last(
188                    java.lang.String uuid,
189                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
190                    throws com.liferay.portal.kernel.exception.SystemException,
191                            com.liferay.portlet.dynamicdatamapping.NoSuchStorageLinkException;
192    
193            /**
194            * Returns the d d m storage links before and after the current d d m storage link in the ordered set where uuid = &#63;.
195            *
196            * <p>
197            * 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.
198            * </p>
199            *
200            * @param storageLinkId the primary key of the current d d m storage link
201            * @param uuid the uuid
202            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
203            * @return the previous, current, and next d d m storage link
204            * @throws com.liferay.portlet.dynamicdatamapping.NoSuchStorageLinkException if a d d m storage link with the primary key could not be found
205            * @throws SystemException if a system exception occurred
206            */
207            public com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink[] findByUuid_PrevAndNext(
208                    long storageLinkId, java.lang.String uuid,
209                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
210                    throws com.liferay.portal.kernel.exception.SystemException,
211                            com.liferay.portlet.dynamicdatamapping.NoSuchStorageLinkException;
212    
213            /**
214            * Returns the d d m storage link where classPK = &#63; or throws a {@link com.liferay.portlet.dynamicdatamapping.NoSuchStorageLinkException} if it could not be found.
215            *
216            * @param classPK the class p k
217            * @return the matching d d m storage link
218            * @throws com.liferay.portlet.dynamicdatamapping.NoSuchStorageLinkException if a matching d d m storage link could not be found
219            * @throws SystemException if a system exception occurred
220            */
221            public com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink findByClassPK(
222                    long classPK)
223                    throws com.liferay.portal.kernel.exception.SystemException,
224                            com.liferay.portlet.dynamicdatamapping.NoSuchStorageLinkException;
225    
226            /**
227            * Returns the d d m storage link where classPK = &#63; or returns <code>null</code> if it could not be found. Uses the finder cache.
228            *
229            * @param classPK the class p k
230            * @return the matching d d m storage link, or <code>null</code> if a matching d d m storage link could not be found
231            * @throws SystemException if a system exception occurred
232            */
233            public com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink fetchByClassPK(
234                    long classPK)
235                    throws com.liferay.portal.kernel.exception.SystemException;
236    
237            /**
238            * Returns the d d m storage link where classPK = &#63; or returns <code>null</code> if it could not be found, optionally using the finder cache.
239            *
240            * @param classPK the class p k
241            * @param retrieveFromCache whether to use the finder cache
242            * @return the matching d d m storage link, or <code>null</code> if a matching d d m storage link could not be found
243            * @throws SystemException if a system exception occurred
244            */
245            public com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink fetchByClassPK(
246                    long classPK, boolean retrieveFromCache)
247                    throws com.liferay.portal.kernel.exception.SystemException;
248    
249            /**
250            * Returns all the d d m storage links where structureId = &#63;.
251            *
252            * @param structureId the structure ID
253            * @return the matching d d m storage links
254            * @throws SystemException if a system exception occurred
255            */
256            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink> findByStructureId(
257                    long structureId)
258                    throws com.liferay.portal.kernel.exception.SystemException;
259    
260            /**
261            * Returns a range of all the d d m storage links where structureId = &#63;.
262            *
263            * <p>
264            * 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.
265            * </p>
266            *
267            * @param structureId the structure ID
268            * @param start the lower bound of the range of d d m storage links
269            * @param end the upper bound of the range of d d m storage links (not inclusive)
270            * @return the range of matching d d m storage links
271            * @throws SystemException if a system exception occurred
272            */
273            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink> findByStructureId(
274                    long structureId, int start, int end)
275                    throws com.liferay.portal.kernel.exception.SystemException;
276    
277            /**
278            * Returns an ordered range of all the d d m storage links where structureId = &#63;.
279            *
280            * <p>
281            * 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.
282            * </p>
283            *
284            * @param structureId the structure ID
285            * @param start the lower bound of the range of d d m storage links
286            * @param end the upper bound of the range of d d m storage links (not inclusive)
287            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
288            * @return the ordered range of matching d d m storage links
289            * @throws SystemException if a system exception occurred
290            */
291            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink> findByStructureId(
292                    long structureId, int start, int end,
293                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
294                    throws com.liferay.portal.kernel.exception.SystemException;
295    
296            /**
297            * Returns the first d d m storage link in the ordered set where structureId = &#63;.
298            *
299            * <p>
300            * 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.
301            * </p>
302            *
303            * @param structureId the structure ID
304            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
305            * @return the first matching d d m storage link
306            * @throws com.liferay.portlet.dynamicdatamapping.NoSuchStorageLinkException if a matching d d m storage link could not be found
307            * @throws SystemException if a system exception occurred
308            */
309            public com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink findByStructureId_First(
310                    long structureId,
311                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
312                    throws com.liferay.portal.kernel.exception.SystemException,
313                            com.liferay.portlet.dynamicdatamapping.NoSuchStorageLinkException;
314    
315            /**
316            * Returns the last d d m storage link in the ordered set where structureId = &#63;.
317            *
318            * <p>
319            * 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.
320            * </p>
321            *
322            * @param structureId the structure ID
323            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
324            * @return the last matching d d m storage link
325            * @throws com.liferay.portlet.dynamicdatamapping.NoSuchStorageLinkException if a matching d d m storage link could not be found
326            * @throws SystemException if a system exception occurred
327            */
328            public com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink findByStructureId_Last(
329                    long structureId,
330                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
331                    throws com.liferay.portal.kernel.exception.SystemException,
332                            com.liferay.portlet.dynamicdatamapping.NoSuchStorageLinkException;
333    
334            /**
335            * Returns the d d m storage links before and after the current d d m storage link in the ordered set where structureId = &#63;.
336            *
337            * <p>
338            * 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.
339            * </p>
340            *
341            * @param storageLinkId the primary key of the current d d m storage link
342            * @param structureId the structure ID
343            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
344            * @return the previous, current, and next d d m storage link
345            * @throws com.liferay.portlet.dynamicdatamapping.NoSuchStorageLinkException if a d d m storage link with the primary key could not be found
346            * @throws SystemException if a system exception occurred
347            */
348            public com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink[] findByStructureId_PrevAndNext(
349                    long storageLinkId, long structureId,
350                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
351                    throws com.liferay.portal.kernel.exception.SystemException,
352                            com.liferay.portlet.dynamicdatamapping.NoSuchStorageLinkException;
353    
354            /**
355            * Returns all the d d m storage links.
356            *
357            * @return the d d m storage links
358            * @throws SystemException if a system exception occurred
359            */
360            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink> findAll()
361                    throws com.liferay.portal.kernel.exception.SystemException;
362    
363            /**
364            * Returns a range of all the d d m storage links.
365            *
366            * <p>
367            * 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.
368            * </p>
369            *
370            * @param start the lower bound of the range of d d m storage links
371            * @param end the upper bound of the range of d d m storage links (not inclusive)
372            * @return the range of d d m storage links
373            * @throws SystemException if a system exception occurred
374            */
375            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink> findAll(
376                    int start, int end)
377                    throws com.liferay.portal.kernel.exception.SystemException;
378    
379            /**
380            * Returns an ordered range of all the d d m storage links.
381            *
382            * <p>
383            * 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.
384            * </p>
385            *
386            * @param start the lower bound of the range of d d m storage links
387            * @param end the upper bound of the range of d d m storage links (not inclusive)
388            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
389            * @return the ordered range of d d m storage links
390            * @throws SystemException if a system exception occurred
391            */
392            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink> findAll(
393                    int start, int end,
394                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
395                    throws com.liferay.portal.kernel.exception.SystemException;
396    
397            /**
398            * Removes all the d d m storage links where uuid = &#63; from the database.
399            *
400            * @param uuid the uuid
401            * @throws SystemException if a system exception occurred
402            */
403            public void removeByUuid(java.lang.String uuid)
404                    throws com.liferay.portal.kernel.exception.SystemException;
405    
406            /**
407            * Removes the d d m storage link where classPK = &#63; from the database.
408            *
409            * @param classPK the class p k
410            * @throws SystemException if a system exception occurred
411            */
412            public void removeByClassPK(long classPK)
413                    throws com.liferay.portal.kernel.exception.SystemException,
414                            com.liferay.portlet.dynamicdatamapping.NoSuchStorageLinkException;
415    
416            /**
417            * Removes all the d d m storage links where structureId = &#63; from the database.
418            *
419            * @param structureId the structure ID
420            * @throws SystemException if a system exception occurred
421            */
422            public void removeByStructureId(long structureId)
423                    throws com.liferay.portal.kernel.exception.SystemException;
424    
425            /**
426            * Removes all the d d m storage links from the database.
427            *
428            * @throws SystemException if a system exception occurred
429            */
430            public void removeAll()
431                    throws com.liferay.portal.kernel.exception.SystemException;
432    
433            /**
434            * Returns the number of d d m storage links where uuid = &#63;.
435            *
436            * @param uuid the uuid
437            * @return the number of matching d d m storage links
438            * @throws SystemException if a system exception occurred
439            */
440            public int countByUuid(java.lang.String uuid)
441                    throws com.liferay.portal.kernel.exception.SystemException;
442    
443            /**
444            * Returns the number of d d m storage links where classPK = &#63;.
445            *
446            * @param classPK the class p k
447            * @return the number of matching d d m storage links
448            * @throws SystemException if a system exception occurred
449            */
450            public int countByClassPK(long classPK)
451                    throws com.liferay.portal.kernel.exception.SystemException;
452    
453            /**
454            * Returns the number of d d m storage links where structureId = &#63;.
455            *
456            * @param structureId the structure ID
457            * @return the number of matching d d m storage links
458            * @throws SystemException if a system exception occurred
459            */
460            public int countByStructureId(long structureId)
461                    throws com.liferay.portal.kernel.exception.SystemException;
462    
463            /**
464            * Returns the number of d d m storage links.
465            *
466            * @return the number of d d m storage links
467            * @throws SystemException if a system exception occurred
468            */
469            public int countAll()
470                    throws com.liferay.portal.kernel.exception.SystemException;
471    
472            public DDMStorageLink remove(DDMStorageLink ddmStorageLink)
473                    throws SystemException;
474    }