001    /**
002     * Copyright (c) 2000-2011 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            /**
150            * Returns the asset category with the primary key.
151            *
152            * @param categoryId the primary key of the asset category
153            * @return the asset category
154            * @throws PortalException if a asset category with the primary key could not be found
155            * @throws SystemException if a system exception occurred
156            */
157            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
158            public com.liferay.portlet.asset.model.AssetCategory getAssetCategory(
159                    long categoryId)
160                    throws com.liferay.portal.kernel.exception.PortalException,
161                            com.liferay.portal.kernel.exception.SystemException;
162    
163            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
164            public com.liferay.portal.model.PersistedModel getPersistedModel(
165                    java.io.Serializable primaryKeyObj)
166                    throws com.liferay.portal.kernel.exception.PortalException,
167                            com.liferay.portal.kernel.exception.SystemException;
168    
169            /**
170            * Returns the asset category with the UUID in the group.
171            *
172            * @param uuid the UUID of asset category
173            * @param groupId the group id of the asset category
174            * @return the asset category
175            * @throws PortalException if a asset category with the UUID in the group could not be found
176            * @throws SystemException if a system exception occurred
177            */
178            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
179            public com.liferay.portlet.asset.model.AssetCategory getAssetCategoryByUuidAndGroupId(
180                    java.lang.String uuid, long groupId)
181                    throws com.liferay.portal.kernel.exception.PortalException,
182                            com.liferay.portal.kernel.exception.SystemException;
183    
184            /**
185            * Returns a range of all the asset categories.
186            *
187            * <p>
188            * 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.
189            * </p>
190            *
191            * @param start the lower bound of the range of asset categories
192            * @param end the upper bound of the range of asset categories (not inclusive)
193            * @return the range of asset categories
194            * @throws SystemException if a system exception occurred
195            */
196            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
197            public java.util.List<com.liferay.portlet.asset.model.AssetCategory> getAssetCategories(
198                    int start, int end)
199                    throws com.liferay.portal.kernel.exception.SystemException;
200    
201            /**
202            * Returns the number of asset categories.
203            *
204            * @return the number of asset categories
205            * @throws SystemException if a system exception occurred
206            */
207            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
208            public int getAssetCategoriesCount()
209                    throws com.liferay.portal.kernel.exception.SystemException;
210    
211            /**
212            * Updates the asset category in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
213            *
214            * @param assetCategory the asset category
215            * @return the asset category that was updated
216            * @throws SystemException if a system exception occurred
217            */
218            public com.liferay.portlet.asset.model.AssetCategory updateAssetCategory(
219                    com.liferay.portlet.asset.model.AssetCategory assetCategory)
220                    throws com.liferay.portal.kernel.exception.SystemException;
221    
222            /**
223            * Updates the asset category in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
224            *
225            * @param assetCategory the asset category
226            * @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.
227            * @return the asset category that was updated
228            * @throws SystemException if a system exception occurred
229            */
230            public com.liferay.portlet.asset.model.AssetCategory updateAssetCategory(
231                    com.liferay.portlet.asset.model.AssetCategory assetCategory,
232                    boolean merge)
233                    throws com.liferay.portal.kernel.exception.SystemException;
234    
235            /**
236            * Returns the Spring bean ID for this bean.
237            *
238            * @return the Spring bean ID for this bean
239            */
240            public java.lang.String getBeanIdentifier();
241    
242            /**
243            * Sets the Spring bean ID for this bean.
244            *
245            * @param beanIdentifier the Spring bean ID for this bean
246            */
247            public void setBeanIdentifier(java.lang.String beanIdentifier);
248    
249            public com.liferay.portlet.asset.model.AssetCategory addCategory(
250                    long userId, long parentCategoryId,
251                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
252                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
253                    long vocabularyId, java.lang.String[] categoryProperties,
254                    com.liferay.portal.service.ServiceContext serviceContext)
255                    throws com.liferay.portal.kernel.exception.PortalException,
256                            com.liferay.portal.kernel.exception.SystemException;
257    
258            public void addCategoryResources(
259                    com.liferay.portlet.asset.model.AssetCategory category,
260                    boolean addGroupPermissions, boolean addGuestPermissions)
261                    throws com.liferay.portal.kernel.exception.PortalException,
262                            com.liferay.portal.kernel.exception.SystemException;
263    
264            public void addCategoryResources(
265                    com.liferay.portlet.asset.model.AssetCategory category,
266                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
267                    throws com.liferay.portal.kernel.exception.PortalException,
268                            com.liferay.portal.kernel.exception.SystemException;
269    
270            public void deleteCategory(
271                    com.liferay.portlet.asset.model.AssetCategory category)
272                    throws com.liferay.portal.kernel.exception.PortalException,
273                            com.liferay.portal.kernel.exception.SystemException;
274    
275            public void deleteCategory(long categoryId)
276                    throws com.liferay.portal.kernel.exception.PortalException,
277                            com.liferay.portal.kernel.exception.SystemException;
278    
279            public void deleteVocabularyCategories(long vocabularyId)
280                    throws com.liferay.portal.kernel.exception.PortalException,
281                            com.liferay.portal.kernel.exception.SystemException;
282    
283            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
284            public com.liferay.portlet.asset.model.AssetCategory fetchCategory(
285                    long categoryId)
286                    throws com.liferay.portal.kernel.exception.SystemException;
287    
288            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
289            public java.util.List<com.liferay.portlet.asset.model.AssetCategory> getCategories()
290                    throws com.liferay.portal.kernel.exception.SystemException;
291    
292            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
293            public java.util.List<com.liferay.portlet.asset.model.AssetCategory> getCategories(
294                    long classNameId, long classPK)
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                    java.lang.String className, long classPK)
300                    throws com.liferay.portal.kernel.exception.SystemException;
301    
302            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
303            public com.liferay.portlet.asset.model.AssetCategory getCategory(
304                    long categoryId)
305                    throws com.liferay.portal.kernel.exception.PortalException,
306                            com.liferay.portal.kernel.exception.SystemException;
307    
308            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
309            public long[] getCategoryIds(java.lang.String className, long classPK)
310                    throws com.liferay.portal.kernel.exception.SystemException;
311    
312            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
313            public java.lang.String[] getCategoryNames()
314                    throws com.liferay.portal.kernel.exception.SystemException;
315    
316            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
317            public java.lang.String[] getCategoryNames(long classNameId, long classPK)
318                    throws com.liferay.portal.kernel.exception.SystemException;
319    
320            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
321            public java.lang.String[] getCategoryNames(java.lang.String className,
322                    long classPK)
323                    throws com.liferay.portal.kernel.exception.SystemException;
324    
325            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
326            public java.util.List<com.liferay.portlet.asset.model.AssetCategory> getChildCategories(
327                    long parentCategoryId)
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, int start, int end,
333                    com.liferay.portal.kernel.util.OrderByComparator obc)
334                    throws com.liferay.portal.kernel.exception.SystemException;
335    
336            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
337            public int getChildCategoriesCount(long parentCategoryId)
338                    throws com.liferay.portal.kernel.exception.SystemException;
339    
340            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
341            public java.util.List<com.liferay.portlet.asset.model.AssetCategory> getEntryCategories(
342                    long entryId)
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> getVocabularyCategories(
347                    long vocabularyId, int start, int end,
348                    com.liferay.portal.kernel.util.OrderByComparator obc)
349                    throws com.liferay.portal.kernel.exception.SystemException;
350    
351            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
352            public java.util.List<com.liferay.portlet.asset.model.AssetCategory> getVocabularyCategories(
353                    long parentCategoryId, long vocabularyId, int start, int end,
354                    com.liferay.portal.kernel.util.OrderByComparator obc)
355                    throws com.liferay.portal.kernel.exception.SystemException;
356    
357            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
358            public int getVocabularyCategoriesCount(long vocabularyId)
359                    throws com.liferay.portal.kernel.exception.SystemException;
360    
361            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
362            public java.util.List<com.liferay.portlet.asset.model.AssetCategory> getVocabularyRootCategories(
363                    long vocabularyId, int start, int end,
364                    com.liferay.portal.kernel.util.OrderByComparator obc)
365                    throws com.liferay.portal.kernel.exception.SystemException;
366    
367            public void mergeCategories(long fromCategoryId, long toCategoryId)
368                    throws com.liferay.portal.kernel.exception.PortalException,
369                            com.liferay.portal.kernel.exception.SystemException;
370    
371            public com.liferay.portlet.asset.model.AssetCategory moveCategory(
372                    long categoryId, long parentCategoryId, long vocabularyId,
373                    com.liferay.portal.service.ServiceContext serviceContext)
374                    throws com.liferay.portal.kernel.exception.PortalException,
375                            com.liferay.portal.kernel.exception.SystemException;
376    
377            public void rebuildTree(long groupId, boolean force)
378                    throws com.liferay.portal.kernel.exception.SystemException;
379    
380            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
381            public java.util.List<com.liferay.portlet.asset.model.AssetCategory> search(
382                    long groupId, java.lang.String name,
383                    java.lang.String[] categoryProperties, int start, int end)
384                    throws com.liferay.portal.kernel.exception.SystemException;
385    
386            public com.liferay.portlet.asset.model.AssetCategory updateCategory(
387                    long userId, long categoryId, long parentCategoryId,
388                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
389                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
390                    long vocabularyId, java.lang.String[] categoryProperties,
391                    com.liferay.portal.service.ServiceContext serviceContext)
392                    throws com.liferay.portal.kernel.exception.PortalException,
393                            com.liferay.portal.kernel.exception.SystemException;
394    }