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