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;
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            */
055            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
056            public com.liferay.portal.model.RepositoryEntry addRepositoryEntry(
057                    com.liferay.portal.model.RepositoryEntry repositoryEntry);
058    
059            public com.liferay.portal.model.RepositoryEntry addRepositoryEntry(
060                    long userId, long groupId, long repositoryId,
061                    java.lang.String mappedId,
062                    com.liferay.portal.service.ServiceContext serviceContext)
063                    throws com.liferay.portal.kernel.exception.PortalException;
064    
065            /**
066            * Creates a new repository entry with the primary key. Does not add the repository entry to the database.
067            *
068            * @param repositoryEntryId the primary key for the new repository entry
069            * @return the new repository entry
070            */
071            public com.liferay.portal.model.RepositoryEntry createRepositoryEntry(
072                    long repositoryEntryId);
073    
074            /**
075            * @throws PortalException
076            */
077            @Override
078            public com.liferay.portal.model.PersistedModel deletePersistedModel(
079                    com.liferay.portal.model.PersistedModel persistedModel)
080                    throws com.liferay.portal.kernel.exception.PortalException;
081    
082            /**
083            * Deletes the repository entry from the database. Also notifies the appropriate model listeners.
084            *
085            * @param repositoryEntry the repository entry
086            * @return the repository entry that was removed
087            */
088            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
089            public com.liferay.portal.model.RepositoryEntry deleteRepositoryEntry(
090                    com.liferay.portal.model.RepositoryEntry repositoryEntry);
091    
092            /**
093            * Deletes the repository entry with the primary key from the database. Also notifies the appropriate model listeners.
094            *
095            * @param repositoryEntryId the primary key of the repository entry
096            * @return the repository entry that was removed
097            * @throws PortalException if a repository entry with the primary key could not be found
098            */
099            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
100            public com.liferay.portal.model.RepositoryEntry deleteRepositoryEntry(
101                    long repositoryEntryId)
102                    throws com.liferay.portal.kernel.exception.PortalException;
103    
104            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
105    
106            /**
107            * Performs a dynamic query on the database and returns the matching rows.
108            *
109            * @param dynamicQuery the dynamic query
110            * @return the matching rows
111            */
112            public <T> java.util.List<T> dynamicQuery(
113                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
114    
115            /**
116            * Performs a dynamic query on the database and returns a range of the matching rows.
117            *
118            * <p>
119            * 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.
120            * </p>
121            *
122            * @param dynamicQuery the dynamic query
123            * @param start the lower bound of the range of model instances
124            * @param end the upper bound of the range of model instances (not inclusive)
125            * @return the range of matching rows
126            */
127            public <T> java.util.List<T> dynamicQuery(
128                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
129                    int end);
130    
131            /**
132            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
133            *
134            * <p>
135            * 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.
136            * </p>
137            *
138            * @param dynamicQuery the dynamic query
139            * @param start the lower bound of the range of model instances
140            * @param end the upper bound of the range of model instances (not inclusive)
141            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
142            * @return the ordered range of matching rows
143            */
144            public <T> java.util.List<T> dynamicQuery(
145                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
146                    int end,
147                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
148    
149            /**
150            * Returns the number of rows matching the dynamic query.
151            *
152            * @param dynamicQuery the dynamic query
153            * @return the number of rows matching the dynamic query
154            */
155            public long dynamicQueryCount(
156                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
157    
158            /**
159            * Returns the number of rows matching the dynamic query.
160            *
161            * @param dynamicQuery the dynamic query
162            * @param projection the projection to apply to the query
163            * @return the number of rows matching the dynamic query
164            */
165            public long dynamicQueryCount(
166                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
167                    com.liferay.portal.kernel.dao.orm.Projection projection);
168    
169            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
170            public com.liferay.portal.model.RepositoryEntry fetchRepositoryEntry(
171                    long repositoryEntryId);
172    
173            /**
174            * Returns the repository entry matching the UUID and group.
175            *
176            * @param uuid the repository entry's UUID
177            * @param groupId the primary key of the group
178            * @return the matching repository entry, or <code>null</code> if a matching repository entry could not be found
179            */
180            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
181            public com.liferay.portal.model.RepositoryEntry fetchRepositoryEntryByUuidAndGroupId(
182                    java.lang.String uuid, long groupId);
183    
184            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
185            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
186    
187            /**
188            * Returns the Spring bean ID for this bean.
189            *
190            * @return the Spring bean ID for this bean
191            */
192            public java.lang.String getBeanIdentifier();
193    
194            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
195            public com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(
196                    com.liferay.portal.kernel.lar.PortletDataContext portletDataContext);
197    
198            @Override
199            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
200            public com.liferay.portal.model.PersistedModel getPersistedModel(
201                    java.io.Serializable primaryKeyObj)
202                    throws com.liferay.portal.kernel.exception.PortalException;
203    
204            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
205            public java.util.List<com.liferay.portal.model.RepositoryEntry> getRepositoryEntries(
206                    long repositoryId);
207    
208            /**
209            * Returns a range of all the repository entries.
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 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.
213            * </p>
214            *
215            * @param start the lower bound of the range of repository entries
216            * @param end the upper bound of the range of repository entries (not inclusive)
217            * @return the range of repository entries
218            */
219            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
220            public java.util.List<com.liferay.portal.model.RepositoryEntry> getRepositoryEntries(
221                    int start, int end);
222    
223            /**
224            * Returns all the repository entries matching the UUID and company.
225            *
226            * @param uuid the UUID of the repository entries
227            * @param companyId the primary key of the company
228            * @return the matching repository entries, or an empty list if no matches were found
229            */
230            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
231            public java.util.List<com.liferay.portal.model.RepositoryEntry> getRepositoryEntriesByUuidAndCompanyId(
232                    java.lang.String uuid, long companyId);
233    
234            /**
235            * Returns a range of repository entries matching the UUID and company.
236            *
237            * @param uuid the UUID of the repository entries
238            * @param companyId the primary key of the company
239            * @param start the lower bound of the range of repository entries
240            * @param end the upper bound of the range of repository entries (not inclusive)
241            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
242            * @return the range of matching repository entries, or an empty list if no matches were found
243            */
244            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
245            public java.util.List<com.liferay.portal.model.RepositoryEntry> getRepositoryEntriesByUuidAndCompanyId(
246                    java.lang.String uuid, long companyId, int start, int end,
247                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.RepositoryEntry> orderByComparator);
248    
249            /**
250            * Returns the number of repository entries.
251            *
252            * @return the number of repository entries
253            */
254            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
255            public int getRepositoryEntriesCount();
256    
257            /**
258            * Returns the repository entry with the primary key.
259            *
260            * @param repositoryEntryId the primary key of the repository entry
261            * @return the repository entry
262            * @throws PortalException if a repository entry with the primary key could not be found
263            */
264            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
265            public com.liferay.portal.model.RepositoryEntry getRepositoryEntry(
266                    long repositoryEntryId)
267                    throws com.liferay.portal.kernel.exception.PortalException;
268    
269            /**
270            * Returns the repository entry matching the UUID and group.
271            *
272            * @param uuid the repository entry's UUID
273            * @param groupId the primary key of the group
274            * @return the matching repository entry
275            * @throws PortalException if a matching repository entry could not be found
276            */
277            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
278            public com.liferay.portal.model.RepositoryEntry getRepositoryEntryByUuidAndGroupId(
279                    java.lang.String uuid, long groupId)
280                    throws com.liferay.portal.kernel.exception.PortalException;
281    
282            /**
283            * Sets the Spring bean ID for this bean.
284            *
285            * @param beanIdentifier the Spring bean ID for this bean
286            */
287            public void setBeanIdentifier(java.lang.String beanIdentifier);
288    
289            /**
290            * Updates the repository entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
291            *
292            * @param repositoryEntry the repository entry
293            * @return the repository entry that was updated
294            */
295            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
296            public com.liferay.portal.model.RepositoryEntry updateRepositoryEntry(
297                    com.liferay.portal.model.RepositoryEntry repositoryEntry);
298    
299            public com.liferay.portal.model.RepositoryEntry updateRepositoryEntry(
300                    long repositoryEntryId, java.lang.String mappedId)
301                    throws com.liferay.portal.kernel.exception.PortalException;
302    }