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.portal.service.persistence;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.model.ServiceComponent;
020    
021    /**
022     * The persistence interface for the service component 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 com.liferay.portal.service.persistence.impl.ServiceComponentPersistenceImpl
030     * @see ServiceComponentUtil
031     * @generated
032     */
033    @ProviderType
034    public interface ServiceComponentPersistence extends BasePersistence<ServiceComponent> {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify or reference this interface directly. Always use {@link ServiceComponentUtil} to access the service component persistence. Modify <code>service.xml</code> and rerun ServiceBuilder to regenerate this interface.
039             */
040    
041            /**
042            * Returns all the service components where buildNamespace = &#63;.
043            *
044            * @param buildNamespace the build namespace
045            * @return the matching service components
046            */
047            public java.util.List<ServiceComponent> findByBuildNamespace(
048                    java.lang.String buildNamespace);
049    
050            /**
051            * Returns a range of all the service components where buildNamespace = &#63;.
052            *
053            * <p>
054            * 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 ServiceComponentModelImpl}. 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.
055            * </p>
056            *
057            * @param buildNamespace the build namespace
058            * @param start the lower bound of the range of service components
059            * @param end the upper bound of the range of service components (not inclusive)
060            * @return the range of matching service components
061            */
062            public java.util.List<ServiceComponent> findByBuildNamespace(
063                    java.lang.String buildNamespace, int start, int end);
064    
065            /**
066            * Returns an ordered range of all the service components where buildNamespace = &#63;.
067            *
068            * <p>
069            * 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 ServiceComponentModelImpl}. 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.
070            * </p>
071            *
072            * @param buildNamespace the build namespace
073            * @param start the lower bound of the range of service components
074            * @param end the upper bound of the range of service components (not inclusive)
075            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
076            * @return the ordered range of matching service components
077            */
078            public java.util.List<ServiceComponent> findByBuildNamespace(
079                    java.lang.String buildNamespace, int start, int end,
080                    com.liferay.portal.kernel.util.OrderByComparator<ServiceComponent> orderByComparator);
081    
082            /**
083            * Returns an ordered range of all the service components where buildNamespace = &#63;.
084            *
085            * <p>
086            * 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 ServiceComponentModelImpl}. 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.
087            * </p>
088            *
089            * @param buildNamespace the build namespace
090            * @param start the lower bound of the range of service components
091            * @param end the upper bound of the range of service components (not inclusive)
092            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
093            * @param retrieveFromCache whether to retrieve from the finder cache
094            * @return the ordered range of matching service components
095            */
096            public java.util.List<ServiceComponent> findByBuildNamespace(
097                    java.lang.String buildNamespace, int start, int end,
098                    com.liferay.portal.kernel.util.OrderByComparator<ServiceComponent> orderByComparator,
099                    boolean retrieveFromCache);
100    
101            /**
102            * Returns the first service component in the ordered set where buildNamespace = &#63;.
103            *
104            * @param buildNamespace the build namespace
105            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
106            * @return the first matching service component
107            * @throws NoSuchServiceComponentException if a matching service component could not be found
108            */
109            public ServiceComponent findByBuildNamespace_First(
110                    java.lang.String buildNamespace,
111                    com.liferay.portal.kernel.util.OrderByComparator<ServiceComponent> orderByComparator)
112                    throws com.liferay.portal.exception.NoSuchServiceComponentException;
113    
114            /**
115            * Returns the first service component in the ordered set where buildNamespace = &#63;.
116            *
117            * @param buildNamespace the build namespace
118            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
119            * @return the first matching service component, or <code>null</code> if a matching service component could not be found
120            */
121            public ServiceComponent fetchByBuildNamespace_First(
122                    java.lang.String buildNamespace,
123                    com.liferay.portal.kernel.util.OrderByComparator<ServiceComponent> orderByComparator);
124    
125            /**
126            * Returns the last service component in the ordered set where buildNamespace = &#63;.
127            *
128            * @param buildNamespace the build namespace
129            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
130            * @return the last matching service component
131            * @throws NoSuchServiceComponentException if a matching service component could not be found
132            */
133            public ServiceComponent findByBuildNamespace_Last(
134                    java.lang.String buildNamespace,
135                    com.liferay.portal.kernel.util.OrderByComparator<ServiceComponent> orderByComparator)
136                    throws com.liferay.portal.exception.NoSuchServiceComponentException;
137    
138            /**
139            * Returns the last service component in the ordered set where buildNamespace = &#63;.
140            *
141            * @param buildNamespace the build namespace
142            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
143            * @return the last matching service component, or <code>null</code> if a matching service component could not be found
144            */
145            public ServiceComponent fetchByBuildNamespace_Last(
146                    java.lang.String buildNamespace,
147                    com.liferay.portal.kernel.util.OrderByComparator<ServiceComponent> orderByComparator);
148    
149            /**
150            * Returns the service components before and after the current service component in the ordered set where buildNamespace = &#63;.
151            *
152            * @param serviceComponentId the primary key of the current service component
153            * @param buildNamespace the build namespace
154            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
155            * @return the previous, current, and next service component
156            * @throws NoSuchServiceComponentException if a service component with the primary key could not be found
157            */
158            public ServiceComponent[] findByBuildNamespace_PrevAndNext(
159                    long serviceComponentId, java.lang.String buildNamespace,
160                    com.liferay.portal.kernel.util.OrderByComparator<ServiceComponent> orderByComparator)
161                    throws com.liferay.portal.exception.NoSuchServiceComponentException;
162    
163            /**
164            * Removes all the service components where buildNamespace = &#63; from the database.
165            *
166            * @param buildNamespace the build namespace
167            */
168            public void removeByBuildNamespace(java.lang.String buildNamespace);
169    
170            /**
171            * Returns the number of service components where buildNamespace = &#63;.
172            *
173            * @param buildNamespace the build namespace
174            * @return the number of matching service components
175            */
176            public int countByBuildNamespace(java.lang.String buildNamespace);
177    
178            /**
179            * Returns the service component where buildNamespace = &#63; and buildNumber = &#63; or throws a {@link NoSuchServiceComponentException} if it could not be found.
180            *
181            * @param buildNamespace the build namespace
182            * @param buildNumber the build number
183            * @return the matching service component
184            * @throws NoSuchServiceComponentException if a matching service component could not be found
185            */
186            public ServiceComponent findByBNS_BNU(java.lang.String buildNamespace,
187                    long buildNumber)
188                    throws com.liferay.portal.exception.NoSuchServiceComponentException;
189    
190            /**
191            * Returns the service component where buildNamespace = &#63; and buildNumber = &#63; or returns <code>null</code> if it could not be found. Uses the finder cache.
192            *
193            * @param buildNamespace the build namespace
194            * @param buildNumber the build number
195            * @return the matching service component, or <code>null</code> if a matching service component could not be found
196            */
197            public ServiceComponent fetchByBNS_BNU(java.lang.String buildNamespace,
198                    long buildNumber);
199    
200            /**
201            * Returns the service component where buildNamespace = &#63; and buildNumber = &#63; or returns <code>null</code> if it could not be found, optionally using the finder cache.
202            *
203            * @param buildNamespace the build namespace
204            * @param buildNumber the build number
205            * @param retrieveFromCache whether to retrieve from the finder cache
206            * @return the matching service component, or <code>null</code> if a matching service component could not be found
207            */
208            public ServiceComponent fetchByBNS_BNU(java.lang.String buildNamespace,
209                    long buildNumber, boolean retrieveFromCache);
210    
211            /**
212            * Removes the service component where buildNamespace = &#63; and buildNumber = &#63; from the database.
213            *
214            * @param buildNamespace the build namespace
215            * @param buildNumber the build number
216            * @return the service component that was removed
217            */
218            public ServiceComponent removeByBNS_BNU(java.lang.String buildNamespace,
219                    long buildNumber)
220                    throws com.liferay.portal.exception.NoSuchServiceComponentException;
221    
222            /**
223            * Returns the number of service components where buildNamespace = &#63; and buildNumber = &#63;.
224            *
225            * @param buildNamespace the build namespace
226            * @param buildNumber the build number
227            * @return the number of matching service components
228            */
229            public int countByBNS_BNU(java.lang.String buildNamespace, long buildNumber);
230    
231            /**
232            * Caches the service component in the entity cache if it is enabled.
233            *
234            * @param serviceComponent the service component
235            */
236            public void cacheResult(ServiceComponent serviceComponent);
237    
238            /**
239            * Caches the service components in the entity cache if it is enabled.
240            *
241            * @param serviceComponents the service components
242            */
243            public void cacheResult(java.util.List<ServiceComponent> serviceComponents);
244    
245            /**
246            * Creates a new service component with the primary key. Does not add the service component to the database.
247            *
248            * @param serviceComponentId the primary key for the new service component
249            * @return the new service component
250            */
251            public ServiceComponent create(long serviceComponentId);
252    
253            /**
254            * Removes the service component with the primary key from the database. Also notifies the appropriate model listeners.
255            *
256            * @param serviceComponentId the primary key of the service component
257            * @return the service component that was removed
258            * @throws NoSuchServiceComponentException if a service component with the primary key could not be found
259            */
260            public ServiceComponent remove(long serviceComponentId)
261                    throws com.liferay.portal.exception.NoSuchServiceComponentException;
262    
263            public ServiceComponent updateImpl(ServiceComponent serviceComponent);
264    
265            /**
266            * Returns the service component with the primary key or throws a {@link NoSuchServiceComponentException} if it could not be found.
267            *
268            * @param serviceComponentId the primary key of the service component
269            * @return the service component
270            * @throws NoSuchServiceComponentException if a service component with the primary key could not be found
271            */
272            public ServiceComponent findByPrimaryKey(long serviceComponentId)
273                    throws com.liferay.portal.exception.NoSuchServiceComponentException;
274    
275            /**
276            * Returns the service component with the primary key or returns <code>null</code> if it could not be found.
277            *
278            * @param serviceComponentId the primary key of the service component
279            * @return the service component, or <code>null</code> if a service component with the primary key could not be found
280            */
281            public ServiceComponent fetchByPrimaryKey(long serviceComponentId);
282    
283            @Override
284            public java.util.Map<java.io.Serializable, ServiceComponent> fetchByPrimaryKeys(
285                    java.util.Set<java.io.Serializable> primaryKeys);
286    
287            /**
288            * Returns all the service components.
289            *
290            * @return the service components
291            */
292            public java.util.List<ServiceComponent> findAll();
293    
294            /**
295            * Returns a range of all the service components.
296            *
297            * <p>
298            * 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 ServiceComponentModelImpl}. 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.
299            * </p>
300            *
301            * @param start the lower bound of the range of service components
302            * @param end the upper bound of the range of service components (not inclusive)
303            * @return the range of service components
304            */
305            public java.util.List<ServiceComponent> findAll(int start, int end);
306    
307            /**
308            * Returns an ordered range of all the service components.
309            *
310            * <p>
311            * 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 ServiceComponentModelImpl}. 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.
312            * </p>
313            *
314            * @param start the lower bound of the range of service components
315            * @param end the upper bound of the range of service components (not inclusive)
316            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
317            * @return the ordered range of service components
318            */
319            public java.util.List<ServiceComponent> findAll(int start, int end,
320                    com.liferay.portal.kernel.util.OrderByComparator<ServiceComponent> orderByComparator);
321    
322            /**
323            * Returns an ordered range of all the service components.
324            *
325            * <p>
326            * 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 ServiceComponentModelImpl}. 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.
327            * </p>
328            *
329            * @param start the lower bound of the range of service components
330            * @param end the upper bound of the range of service components (not inclusive)
331            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
332            * @param retrieveFromCache whether to retrieve from the finder cache
333            * @return the ordered range of service components
334            */
335            public java.util.List<ServiceComponent> findAll(int start, int end,
336                    com.liferay.portal.kernel.util.OrderByComparator<ServiceComponent> orderByComparator,
337                    boolean retrieveFromCache);
338    
339            /**
340            * Removes all the service components from the database.
341            */
342            public void removeAll();
343    
344            /**
345            * Returns the number of service components.
346            *
347            * @return the number of service components
348            */
349            public int countAll();
350    
351            @Override
352            public java.util.Set<java.lang.String> getBadColumnNames();
353    }