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