001    /**
002     * Copyright (c) 2000-2012 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.asset.service;
016    
017    import com.liferay.portal.kernel.exception.PortalException;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.kernel.transaction.Isolation;
020    import com.liferay.portal.kernel.transaction.Propagation;
021    import com.liferay.portal.kernel.transaction.Transactional;
022    import com.liferay.portal.service.PersistedModelLocalService;
023    
024    /**
025     * The interface for the asset category local service.
026     *
027     * <p>
028     * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
029     * </p>
030     *
031     * @author Brian Wing Shun Chan
032     * @see AssetCategoryLocalServiceUtil
033     * @see com.liferay.portlet.asset.service.base.AssetCategoryLocalServiceBaseImpl
034     * @see com.liferay.portlet.asset.service.impl.AssetCategoryLocalServiceImpl
035     * @generated
036     */
037    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
038            PortalException.class, SystemException.class})
039    public interface AssetCategoryLocalService extends PersistedModelLocalService {
040            /*
041             * NOTE FOR DEVELOPERS:
042             *
043             * Never modify or reference this interface directly. Always use {@link AssetCategoryLocalServiceUtil} to access the asset category local service. Add custom service methods to {@link com.liferay.portlet.asset.service.impl.AssetCategoryLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
044             */
045    
046            /**
047            * Adds the asset category to the database. Also notifies the appropriate model listeners.
048            *
049            * @param assetCategory the asset category
050            * @return the asset category that was added
051            * @throws SystemException if a system exception occurred
052            */
053            public com.liferay.portlet.asset.model.AssetCategory addAssetCategory(
054                    com.liferay.portlet.asset.model.AssetCategory assetCategory)
055                    throws com.liferay.portal.kernel.exception.SystemException;
056    
057            /**
058            * Creates a new asset category with the primary key. Does not add the asset category to the database.
059            *
060            * @param categoryId the primary key for the new asset category
061            * @return the new asset category
062            */
063            public com.liferay.portlet.asset.model.AssetCategory createAssetCategory(
064                    long categoryId);
065    
066            /**
067            * Deletes the asset category with the primary key from the database. Also notifies the appropriate model listeners.
068            *
069            * @param categoryId the primary key of the asset category
070            * @throws PortalException if a asset category with the primary key could not be found
071            * @throws SystemException if a system exception occurred
072            */
073            public void deleteAssetCategory(long categoryId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException;
076    
077            /**
078            * Deletes the asset category from the database. Also notifies the appropriate model listeners.
079            *
080            * @param assetCategory the asset category
081            * @throws SystemException if a system exception occurred
082            */
083            public void deleteAssetCategory(
084                    com.liferay.portlet.asset.model.AssetCategory assetCategory)
085                    throws com.liferay.portal.kernel.exception.SystemException;
086    
087            /**
088            * Performs a dynamic query on the database and returns the matching rows.
089            *
090            * @param dynamicQuery the dynamic query
091            * @return the matching rows
092            * @throws SystemException if a system exception occurred
093            */
094            @SuppressWarnings("rawtypes")
095            public java.util.List dynamicQuery(
096                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
097                    throws com.liferay.portal.kernel.exception.SystemException;
098    
099            /**
100            * Performs a dynamic query on the database and returns a range of the matching rows.
101            *
102            * <p>
103            * 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.
104            * </p>
105            *
106            * @param dynamicQuery the dynamic query
107            * @param start the lower bound of the range of model instances
108            * @param end the upper bound of the range of model instances (not inclusive)
109            * @return the range of matching rows
110            * @throws SystemException if a system exception occurred
111            */
112            @SuppressWarnings("rawtypes")
113            public java.util.List dynamicQuery(
114                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
115                    int end) throws com.liferay.portal.kernel.exception.SystemException;
116    
117            /**
118            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
119            *
120            * <p>
121            * 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.
122            * </p>
123            *
124            * @param dynamicQuery the dynamic query
125            * @param start the lower bound of the range of model instances
126            * @param end the upper bound of the range of model instances (not inclusive)
127            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
128            * @return the ordered range of matching rows
129            * @throws SystemException if a system exception occurred
130            */
131            @SuppressWarnings("rawtypes")
132            public java.util.List dynamicQuery(
133                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
134                    int end,
135                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
136                    throws com.liferay.portal.kernel.exception.SystemException;
137    
138            /**
139            * Returns the number of rows that match the dynamic query.
140            *
141            * @param dynamicQuery the dynamic query
142            * @return the number of rows that match the dynamic query
143            * @throws SystemException if a system exception occurred
144            */
145            public long dynamicQueryCount(
146                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
147                    throws com.liferay.portal.kernel.exception.SystemException;
148    
149            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
150            public com.liferay.portlet.asset.model.AssetCategory fetchAssetCategory(
151                    long categoryId)
152                    throws com.liferay.portal.kernel.exception.SystemException;
153    
154            /**
155            * Returns the asset category with the primary key.
156            *
157            * @param categoryId the primary key of the asset category
158            * @return the asset category
159            * @throws PortalException if a asset category with the primary key could not be found
160            * @throws SystemException if a system exception occurred
161            */
162            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
163            public com.liferay.portlet.asset.model.AssetCategory getAssetCategory(
164                    long categoryId)
165                    throws com.liferay.portal.kernel.exception.PortalException,
166                            com.liferay.portal.kernel.exception.SystemException;
167    
168            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
169            public com.liferay.portal.model.PersistedModel getPersistedModel(
170                    java.io.Serializable primaryKeyObj)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException;
173    
174            /**
175            * Returns the asset category with the UUID in the group.
176            *
177            * @param uuid the UUID of asset category
178            * @param groupId the group id of the asset category
179            * @return the asset category
180            * @throws PortalException if a asset category with the UUID in the group could not be found
181            * @throws SystemException if a system exception occurred
182            */
183            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
184            public com.liferay.portlet.asset.model.AssetCategory getAssetCategoryByUuidAndGroupId(
185                    java.lang.String uuid, long groupId)
186                    throws com.liferay.portal.kernel.exception.PortalException,
187                            com.liferay.portal.kernel.exception.SystemException;
188    
189            /**
190            * Returns a range of all the asset categories.
191            *
192            * <p>
193            * 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.
194            * </p>
195            *
196            * @param start the lower bound of the range of asset categories
197            * @param end the upper bound of the range of asset categories (not inclusive)
198            * @return the range of asset categories
199            * @throws SystemException if a system exception occurred
200            */
201            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
202            public java.util.List<com.liferay.portlet.asset.model.AssetCategory> getAssetCategories(
203                    int start, int end)
204                    throws com.liferay.portal.kernel.exception.SystemException;
205    
206            /**
207            * Returns the number of asset categories.
208            *
209            * @return the number of asset categories
210            * @throws SystemException if a system exception occurred
211            */
212            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
213            public int getAssetCategoriesCount()
214                    throws com.liferay.portal.kernel.exception.SystemException;
215    
216            /**
217            * Updates the asset category in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
218            *
219            * @param assetCategory the asset category
220            * @return the asset category that was updated
221            * @throws SystemException if a system exception occurred
222            */
223            public com.liferay.portlet.asset.model.AssetCategory updateAssetCategory(
224                    com.liferay.portlet.asset.model.AssetCategory assetCategory)
225                    throws com.liferay.portal.kernel.exception.SystemException;
226    
227            /**
228            * Updates the asset category in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
229            *
230            * @param assetCategory the asset category
231            * @param merge whether to merge the asset category with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
232            * @return the asset category that was updated
233            * @throws SystemException if a system exception occurred
234            */
235            public com.liferay.portlet.asset.model.AssetCategory updateAssetCategory(
236                    com.liferay.portlet.asset.model.AssetCategory assetCategory,
237                    boolean merge)
238                    throws com.liferay.portal.kernel.exception.SystemException;
239    
240            /**
241            * Returns the Spring bean ID for this bean.
242            *
243            * @return the Spring bean ID for this bean
244            */
245            public java.lang.String getBeanIdentifier();
246    
247            /**
248            * Sets the Spring bean ID for this bean.
249            *
250            * @param beanIdentifier the Spring bean ID for this bean
251            */
252            public void setBeanIdentifier(java.lang.String beanIdentifier);
253    
254            public com.liferay.portlet.asset.model.AssetCategory addCategory(
255                    long userId, long parentCategoryId,
256                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
257                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
258                    long vocabularyId, java.lang.String[] categoryProperties,
259                    com.liferay.portal.service.ServiceContext serviceContext)
260                    throws com.liferay.portal.kernel.exception.PortalException,
261                            com.liferay.portal.kernel.exception.SystemException;
262    
263            public void addCategoryResources(
264                    com.liferay.portlet.asset.model.AssetCategory category,
265                    boolean addGroupPermissions, boolean addGuestPermissions)
266                    throws com.liferay.portal.kernel.exception.PortalException,
267                            com.liferay.portal.kernel.exception.SystemException;
268    
269            public void addCategoryResources(
270                    com.liferay.portlet.asset.model.AssetCategory category,
271                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
272                    throws com.liferay.portal.kernel.exception.PortalException,
273                            com.liferay.portal.kernel.exception.SystemException;
274    
275            public void deleteCategory(
276                    com.liferay.portlet.asset.model.AssetCategory category)
277                    throws com.liferay.portal.kernel.exception.PortalException,
278                            com.liferay.portal.kernel.exception.SystemException;
279    
280            public void deleteCategory(long categoryId)
281                    throws com.liferay.portal.kernel.exception.PortalException,
282                            com.liferay.portal.kernel.exception.SystemException;
283    
284            public void deleteVocabularyCategories(long vocabularyId)
285                    throws com.liferay.portal.kernel.exception.PortalException,
286                            com.liferay.portal.kernel.exception.SystemException;
287    
288            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
289            public com.liferay.portlet.asset.model.AssetCategory fetchCategory(
290                    long categoryId)
291                    throws com.liferay.portal.kernel.exception.SystemException;
292    
293            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
294            public java.util.List<com.liferay.portlet.asset.model.AssetCategory> getCategories()
295                    throws com.liferay.portal.kernel.exception.SystemException;
296    
297            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
298            public java.util.List<com.liferay.portlet.asset.model.AssetCategory> getCategories(
299                    long classNameId, long classPK)
300                    throws com.liferay.portal.kernel.exception.SystemException;
301    
302            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
303            public java.util.List<com.liferay.portlet.asset.model.AssetCategory> getCategories(
304                    java.lang.String className, long classPK)
305                    throws com.liferay.portal.kernel.exception.SystemException;
306    
307            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
308            public com.liferay.portlet.asset.model.AssetCategory getCategory(
309                    long categoryId)
310                    throws com.liferay.portal.kernel.exception.PortalException,
311                            com.liferay.portal.kernel.exception.SystemException;
312    
313            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
314            public long[] getCategoryIds(java.lang.String className, long classPK)
315                    throws com.liferay.portal.kernel.exception.SystemException;
316    
317            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
318            public java.lang.String[] getCategoryNames()
319                    throws com.liferay.portal.kernel.exception.SystemException;
320    
321            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
322            public java.lang.String[] getCategoryNames(long classNameId, long classPK)
323                    throws com.liferay.portal.kernel.exception.SystemException;
324    
325            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
326            public java.lang.String[] getCategoryNames(java.lang.String className,
327                    long classPK)
328                    throws com.liferay.portal.kernel.exception.SystemException;
329    
330            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
331            public java.util.List<com.liferay.portlet.asset.model.AssetCategory> getChildCategories(
332                    long parentCategoryId)
333                    throws com.liferay.portal.kernel.exception.SystemException;
334    
335            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
336            public java.util.List<com.liferay.portlet.asset.model.AssetCategory> getChildCategories(
337                    long parentCategoryId, int start, int end,
338                    com.liferay.portal.kernel.util.OrderByComparator obc)
339                    throws com.liferay.portal.kernel.exception.SystemException;
340    
341            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
342            public int getChildCategoriesCount(long parentCategoryId)
343                    throws com.liferay.portal.kernel.exception.SystemException;
344    
345            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
346            public java.util.List<com.liferay.portlet.asset.model.AssetCategory> getEntryCategories(
347                    long entryId)
348                    throws com.liferay.portal.kernel.exception.SystemException;
349    
350            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
351            public java.util.List<com.liferay.portlet.asset.model.AssetCategory> getVocabularyCategories(
352                    long vocabularyId, int start, int end,
353                    com.liferay.portal.kernel.util.OrderByComparator obc)
354                    throws com.liferay.portal.kernel.exception.SystemException;
355    
356            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
357            public java.util.List<com.liferay.portlet.asset.model.AssetCategory> getVocabularyCategories(
358                    long parentCategoryId, long vocabularyId, int start, int end,
359                    com.liferay.portal.kernel.util.OrderByComparator obc)
360                    throws com.liferay.portal.kernel.exception.SystemException;
361    
362            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
363            public int getVocabularyCategoriesCount(long vocabularyId)
364                    throws com.liferay.portal.kernel.exception.SystemException;
365    
366            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
367            public java.util.List<com.liferay.portlet.asset.model.AssetCategory> getVocabularyRootCategories(
368                    long vocabularyId, int start, int end,
369                    com.liferay.portal.kernel.util.OrderByComparator obc)
370                    throws com.liferay.portal.kernel.exception.SystemException;
371    
372            public void mergeCategories(long fromCategoryId, long toCategoryId)
373                    throws com.liferay.portal.kernel.exception.PortalException,
374                            com.liferay.portal.kernel.exception.SystemException;
375    
376            public com.liferay.portlet.asset.model.AssetCategory moveCategory(
377                    long categoryId, long parentCategoryId, long vocabularyId,
378                    com.liferay.portal.service.ServiceContext serviceContext)
379                    throws com.liferay.portal.kernel.exception.PortalException,
380                            com.liferay.portal.kernel.exception.SystemException;
381    
382            public void rebuildTree(long groupId, boolean force)
383                    throws com.liferay.portal.kernel.exception.SystemException;
384    
385            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
386            public java.util.List<com.liferay.portlet.asset.model.AssetCategory> search(
387                    long groupId, java.lang.String name,
388                    java.lang.String[] categoryProperties, int start, int end)
389                    throws com.liferay.portal.kernel.exception.SystemException;
390    
391            public com.liferay.portlet.asset.model.AssetCategory updateCategory(
392                    long userId, long categoryId, long parentCategoryId,
393                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
394                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
395                    long vocabularyId, java.lang.String[] categoryProperties,
396                    com.liferay.portal.service.ServiceContext serviceContext)
397                    throws com.liferay.portal.kernel.exception.PortalException,
398                            com.liferay.portal.kernel.exception.SystemException;
399    }