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.portal.service;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.exception.PortalException;
020    import com.liferay.portal.kernel.exception.SystemException;
021    import com.liferay.portal.kernel.search.IndexableType;
022    import com.liferay.portal.kernel.transaction.Isolation;
023    import com.liferay.portal.kernel.transaction.Propagation;
024    import com.liferay.portal.kernel.transaction.Transactional;
025    
026    /**
027     * Provides the local service interface for RepositoryEntry. Methods of this
028     * service will not have security checks based on the propagated JAAS
029     * credentials because this service can only be accessed from within the same
030     * VM.
031     *
032     * @author Brian Wing Shun Chan
033     * @see RepositoryEntryLocalServiceUtil
034     * @see com.liferay.portal.service.base.RepositoryEntryLocalServiceBaseImpl
035     * @see com.liferay.portal.service.impl.RepositoryEntryLocalServiceImpl
036     * @generated
037     */
038    @ProviderType
039    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
040            PortalException.class, SystemException.class})
041    public interface RepositoryEntryLocalService extends BaseLocalService,
042            PersistedModelLocalService {
043            /*
044             * NOTE FOR DEVELOPERS:
045             *
046             * Never modify or reference this interface directly. Always use {@link RepositoryEntryLocalServiceUtil} to access the repository entry local service. Add custom service methods to {@link com.liferay.portal.service.impl.RepositoryEntryLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
047             */
048    
049            /**
050            * Adds the repository entry to the database. Also notifies the appropriate model listeners.
051            *
052            * @param repositoryEntry the repository entry
053            * @return the repository entry that was added
054            * @throws SystemException if a system exception occurred
055            */
056            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
057            public com.liferay.portal.model.RepositoryEntry addRepositoryEntry(
058                    com.liferay.portal.model.RepositoryEntry repositoryEntry)
059                    throws com.liferay.portal.kernel.exception.SystemException;
060    
061            /**
062            * Creates a new repository entry with the primary key. Does not add the repository entry to the database.
063            *
064            * @param repositoryEntryId the primary key for the new repository entry
065            * @return the new repository entry
066            */
067            public com.liferay.portal.model.RepositoryEntry createRepositoryEntry(
068                    long repositoryEntryId);
069    
070            /**
071            * Deletes the repository entry with the primary key from the database. Also notifies the appropriate model listeners.
072            *
073            * @param repositoryEntryId the primary key of the repository entry
074            * @return the repository entry that was removed
075            * @throws PortalException if a repository entry with the primary key could not be found
076            * @throws SystemException if a system exception occurred
077            */
078            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
079            public com.liferay.portal.model.RepositoryEntry deleteRepositoryEntry(
080                    long repositoryEntryId)
081                    throws com.liferay.portal.kernel.exception.PortalException,
082                            com.liferay.portal.kernel.exception.SystemException;
083    
084            /**
085            * Deletes the repository entry from the database. Also notifies the appropriate model listeners.
086            *
087            * @param repositoryEntry the repository entry
088            * @return the repository entry that was removed
089            * @throws SystemException if a system exception occurred
090            */
091            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
092            public com.liferay.portal.model.RepositoryEntry deleteRepositoryEntry(
093                    com.liferay.portal.model.RepositoryEntry repositoryEntry)
094                    throws com.liferay.portal.kernel.exception.SystemException;
095    
096            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
097    
098            /**
099            * Performs a dynamic query on the database and returns the matching rows.
100            *
101            * @param dynamicQuery the dynamic query
102            * @return the matching rows
103            * @throws SystemException if a system exception occurred
104            */
105            @SuppressWarnings("rawtypes")
106            public java.util.List dynamicQuery(
107                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
108                    throws com.liferay.portal.kernel.exception.SystemException;
109    
110            /**
111            * Performs a dynamic query on the database and returns a range of the matching rows.
112            *
113            * <p>
114            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. 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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.RepositoryEntryModelImpl}. 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.
115            * </p>
116            *
117            * @param dynamicQuery the dynamic query
118            * @param start the lower bound of the range of model instances
119            * @param end the upper bound of the range of model instances (not inclusive)
120            * @return the range of matching rows
121            * @throws SystemException if a system exception occurred
122            */
123            @SuppressWarnings("rawtypes")
124            public java.util.List dynamicQuery(
125                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
126                    int end) throws com.liferay.portal.kernel.exception.SystemException;
127    
128            /**
129            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
130            *
131            * <p>
132            * 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. 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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.RepositoryEntryModelImpl}. 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.
133            * </p>
134            *
135            * @param dynamicQuery the dynamic query
136            * @param start the lower bound of the range of model instances
137            * @param end the upper bound of the range of model instances (not inclusive)
138            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
139            * @return the ordered range of matching rows
140            * @throws SystemException if a system exception occurred
141            */
142            @SuppressWarnings("rawtypes")
143            public java.util.List dynamicQuery(
144                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
145                    int end,
146                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
147                    throws com.liferay.portal.kernel.exception.SystemException;
148    
149            /**
150            * Returns the number of rows that match the dynamic query.
151            *
152            * @param dynamicQuery the dynamic query
153            * @return the number of rows that match the dynamic query
154            * @throws SystemException if a system exception occurred
155            */
156            public long dynamicQueryCount(
157                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
158                    throws com.liferay.portal.kernel.exception.SystemException;
159    
160            /**
161            * Returns the number of rows that match the dynamic query.
162            *
163            * @param dynamicQuery the dynamic query
164            * @param projection the projection to apply to the query
165            * @return the number of rows that match the dynamic query
166            * @throws SystemException if a system exception occurred
167            */
168            public long dynamicQueryCount(
169                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
170                    com.liferay.portal.kernel.dao.orm.Projection projection)
171                    throws com.liferay.portal.kernel.exception.SystemException;
172    
173            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
174            public com.liferay.portal.model.RepositoryEntry fetchRepositoryEntry(
175                    long repositoryEntryId)
176                    throws com.liferay.portal.kernel.exception.SystemException;
177    
178            /**
179            * Returns the repository entry with the matching UUID and company.
180            *
181            * @param uuid the repository entry's UUID
182            * @param companyId the primary key of the company
183            * @return the matching repository entry, or <code>null</code> if a matching repository entry could not be found
184            * @throws SystemException if a system exception occurred
185            */
186            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
187            public com.liferay.portal.model.RepositoryEntry fetchRepositoryEntryByUuidAndCompanyId(
188                    java.lang.String uuid, long companyId)
189                    throws com.liferay.portal.kernel.exception.SystemException;
190    
191            /**
192            * Returns the repository entry matching the UUID and group.
193            *
194            * @param uuid the repository entry's UUID
195            * @param groupId the primary key of the group
196            * @return the matching repository entry, or <code>null</code> if a matching repository entry could not be found
197            * @throws SystemException if a system exception occurred
198            */
199            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
200            public com.liferay.portal.model.RepositoryEntry fetchRepositoryEntryByUuidAndGroupId(
201                    java.lang.String uuid, long groupId)
202                    throws com.liferay.portal.kernel.exception.SystemException;
203    
204            /**
205            * Returns the repository entry with the primary key.
206            *
207            * @param repositoryEntryId the primary key of the repository entry
208            * @return the repository entry
209            * @throws PortalException if a repository entry with the primary key could not be found
210            * @throws SystemException if a system exception occurred
211            */
212            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
213            public com.liferay.portal.model.RepositoryEntry getRepositoryEntry(
214                    long repositoryEntryId)
215                    throws com.liferay.portal.kernel.exception.PortalException,
216                            com.liferay.portal.kernel.exception.SystemException;
217    
218            @Override
219            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
220            public com.liferay.portal.model.PersistedModel getPersistedModel(
221                    java.io.Serializable primaryKeyObj)
222                    throws com.liferay.portal.kernel.exception.PortalException,
223                            com.liferay.portal.kernel.exception.SystemException;
224    
225            /**
226            * Returns the repository entry with the matching UUID and company.
227            *
228            * @param uuid the repository entry's UUID
229            * @param companyId the primary key of the company
230            * @return the matching repository entry
231            * @throws PortalException if a matching repository entry could not be found
232            * @throws SystemException if a system exception occurred
233            */
234            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
235            public com.liferay.portal.model.RepositoryEntry getRepositoryEntryByUuidAndCompanyId(
236                    java.lang.String uuid, long companyId)
237                    throws com.liferay.portal.kernel.exception.PortalException,
238                            com.liferay.portal.kernel.exception.SystemException;
239    
240            /**
241            * Returns the repository entry matching the UUID and group.
242            *
243            * @param uuid the repository entry's UUID
244            * @param groupId the primary key of the group
245            * @return the matching repository entry
246            * @throws PortalException if a matching repository entry could not be found
247            * @throws SystemException if a system exception occurred
248            */
249            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
250            public com.liferay.portal.model.RepositoryEntry getRepositoryEntryByUuidAndGroupId(
251                    java.lang.String uuid, long groupId)
252                    throws com.liferay.portal.kernel.exception.PortalException,
253                            com.liferay.portal.kernel.exception.SystemException;
254    
255            /**
256            * Returns a range of all the repository entries.
257            *
258            * <p>
259            * 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. 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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.RepositoryEntryModelImpl}. 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.
260            * </p>
261            *
262            * @param start the lower bound of the range of repository entries
263            * @param end the upper bound of the range of repository entries (not inclusive)
264            * @return the range of repository entries
265            * @throws SystemException if a system exception occurred
266            */
267            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
268            public java.util.List<com.liferay.portal.model.RepositoryEntry> getRepositoryEntries(
269                    int start, int end)
270                    throws com.liferay.portal.kernel.exception.SystemException;
271    
272            /**
273            * Returns the number of repository entries.
274            *
275            * @return the number of repository entries
276            * @throws SystemException if a system exception occurred
277            */
278            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
279            public int getRepositoryEntriesCount()
280                    throws com.liferay.portal.kernel.exception.SystemException;
281    
282            /**
283            * Updates the repository entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
284            *
285            * @param repositoryEntry the repository entry
286            * @return the repository entry that was updated
287            * @throws SystemException if a system exception occurred
288            */
289            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
290            public com.liferay.portal.model.RepositoryEntry updateRepositoryEntry(
291                    com.liferay.portal.model.RepositoryEntry repositoryEntry)
292                    throws com.liferay.portal.kernel.exception.SystemException;
293    
294            /**
295            * Returns the Spring bean ID for this bean.
296            *
297            * @return the Spring bean ID for this bean
298            */
299            public java.lang.String getBeanIdentifier();
300    
301            /**
302            * Sets the Spring bean ID for this bean.
303            *
304            * @param beanIdentifier the Spring bean ID for this bean
305            */
306            public void setBeanIdentifier(java.lang.String beanIdentifier);
307    
308            public com.liferay.portal.model.RepositoryEntry addRepositoryEntry(
309                    long userId, long groupId, long repositoryId,
310                    java.lang.String mappedId,
311                    com.liferay.portal.service.ServiceContext serviceContext)
312                    throws com.liferay.portal.kernel.exception.PortalException,
313                            com.liferay.portal.kernel.exception.SystemException;
314    
315            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
316            public java.util.List<com.liferay.portal.model.RepositoryEntry> getRepositoryEntries(
317                    long repositoryId)
318                    throws com.liferay.portal.kernel.exception.SystemException;
319    
320            public com.liferay.portal.model.RepositoryEntry updateRepositoryEntry(
321                    long repositoryEntryId, java.lang.String mappedId)
322                    throws com.liferay.portal.kernel.exception.PortalException,
323                            com.liferay.portal.kernel.exception.SystemException;
324    }