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 vocabulary 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 AssetVocabularyLocalServiceUtil
033     * @see com.liferay.portlet.asset.service.base.AssetVocabularyLocalServiceBaseImpl
034     * @see com.liferay.portlet.asset.service.impl.AssetVocabularyLocalServiceImpl
035     * @generated
036     */
037    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
038            PortalException.class, SystemException.class})
039    public interface AssetVocabularyLocalService extends PersistedModelLocalService {
040            /*
041             * NOTE FOR DEVELOPERS:
042             *
043             * Never modify or reference this interface directly. Always use {@link AssetVocabularyLocalServiceUtil} to access the asset vocabulary local service. Add custom service methods to {@link com.liferay.portlet.asset.service.impl.AssetVocabularyLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
044             */
045    
046            /**
047            * Adds the asset vocabulary to the database. Also notifies the appropriate model listeners.
048            *
049            * @param assetVocabulary the asset vocabulary
050            * @return the asset vocabulary that was added
051            * @throws SystemException if a system exception occurred
052            */
053            public com.liferay.portlet.asset.model.AssetVocabulary addAssetVocabulary(
054                    com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary)
055                    throws com.liferay.portal.kernel.exception.SystemException;
056    
057            /**
058            * Creates a new asset vocabulary with the primary key. Does not add the asset vocabulary to the database.
059            *
060            * @param vocabularyId the primary key for the new asset vocabulary
061            * @return the new asset vocabulary
062            */
063            public com.liferay.portlet.asset.model.AssetVocabulary createAssetVocabulary(
064                    long vocabularyId);
065    
066            /**
067            * Deletes the asset vocabulary with the primary key from the database. Also notifies the appropriate model listeners.
068            *
069            * @param vocabularyId the primary key of the asset vocabulary
070            * @throws PortalException if a asset vocabulary with the primary key could not be found
071            * @throws SystemException if a system exception occurred
072            */
073            public void deleteAssetVocabulary(long vocabularyId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException;
076    
077            /**
078            * Deletes the asset vocabulary from the database. Also notifies the appropriate model listeners.
079            *
080            * @param assetVocabulary the asset vocabulary
081            * @throws SystemException if a system exception occurred
082            */
083            public void deleteAssetVocabulary(
084                    com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary)
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 vocabulary with the primary key.
151            *
152            * @param vocabularyId the primary key of the asset vocabulary
153            * @return the asset vocabulary
154            * @throws PortalException if a asset vocabulary 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.AssetVocabulary getAssetVocabulary(
159                    long vocabularyId)
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 vocabulary with the UUID in the group.
171            *
172            * @param uuid the UUID of asset vocabulary
173            * @param groupId the group id of the asset vocabulary
174            * @return the asset vocabulary
175            * @throws PortalException if a asset vocabulary 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.AssetVocabulary getAssetVocabularyByUuidAndGroupId(
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 vocabularies.
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 vocabularies
192            * @param end the upper bound of the range of asset vocabularies (not inclusive)
193            * @return the range of asset vocabularies
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.AssetVocabulary> getAssetVocabularies(
198                    int start, int end)
199                    throws com.liferay.portal.kernel.exception.SystemException;
200    
201            /**
202            * Returns the number of asset vocabularies.
203            *
204            * @return the number of asset vocabularies
205            * @throws SystemException if a system exception occurred
206            */
207            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
208            public int getAssetVocabulariesCount()
209                    throws com.liferay.portal.kernel.exception.SystemException;
210    
211            /**
212            * Updates the asset vocabulary in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
213            *
214            * @param assetVocabulary the asset vocabulary
215            * @return the asset vocabulary that was updated
216            * @throws SystemException if a system exception occurred
217            */
218            public com.liferay.portlet.asset.model.AssetVocabulary updateAssetVocabulary(
219                    com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary)
220                    throws com.liferay.portal.kernel.exception.SystemException;
221    
222            /**
223            * Updates the asset vocabulary in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
224            *
225            * @param assetVocabulary the asset vocabulary
226            * @param merge whether to merge the asset vocabulary 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 vocabulary that was updated
228            * @throws SystemException if a system exception occurred
229            */
230            public com.liferay.portlet.asset.model.AssetVocabulary updateAssetVocabulary(
231                    com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary,
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            /**
250            * @deprecated
251            */
252            public com.liferay.portlet.asset.model.AssetVocabulary addVocabulary(
253                    long userId,
254                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
255                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
256                    java.lang.String settings,
257                    com.liferay.portal.service.ServiceContext serviceContext)
258                    throws com.liferay.portal.kernel.exception.PortalException,
259                            com.liferay.portal.kernel.exception.SystemException;
260    
261            public com.liferay.portlet.asset.model.AssetVocabulary addVocabulary(
262                    long userId, java.lang.String title,
263                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
264                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
265                    java.lang.String settings,
266                    com.liferay.portal.service.ServiceContext serviceContext)
267                    throws com.liferay.portal.kernel.exception.PortalException,
268                            com.liferay.portal.kernel.exception.SystemException;
269    
270            public void addVocabularyResources(
271                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary,
272                    boolean addGroupPermissions, boolean addGuestPermissions)
273                    throws com.liferay.portal.kernel.exception.PortalException,
274                            com.liferay.portal.kernel.exception.SystemException;
275    
276            public void addVocabularyResources(
277                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary,
278                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
279                    throws com.liferay.portal.kernel.exception.PortalException,
280                            com.liferay.portal.kernel.exception.SystemException;
281    
282            public void deleteVocabulary(
283                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary)
284                    throws com.liferay.portal.kernel.exception.PortalException,
285                            com.liferay.portal.kernel.exception.SystemException;
286    
287            public void deleteVocabulary(long vocabularyId)
288                    throws com.liferay.portal.kernel.exception.PortalException,
289                            com.liferay.portal.kernel.exception.SystemException;
290    
291            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
292            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getCompanyVocabularies(
293                    long companyId)
294                    throws com.liferay.portal.kernel.exception.SystemException;
295    
296            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
297            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupsVocabularies(
298                    long[] groupIds)
299                    throws com.liferay.portal.kernel.exception.PortalException,
300                            com.liferay.portal.kernel.exception.SystemException;
301    
302            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
303            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupsVocabularies(
304                    long[] groupIds, java.lang.String className)
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 java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupVocabularies(
310                    long groupId)
311                    throws com.liferay.portal.kernel.exception.PortalException,
312                            com.liferay.portal.kernel.exception.SystemException;
313    
314            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
315            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupVocabularies(
316                    long groupId, boolean createDefaultVocabulary)
317                    throws com.liferay.portal.kernel.exception.PortalException,
318                            com.liferay.portal.kernel.exception.SystemException;
319    
320            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
321            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupVocabularies(
322                    long groupId, java.lang.String name, int start, int end,
323                    com.liferay.portal.kernel.util.OrderByComparator obc)
324                    throws com.liferay.portal.kernel.exception.SystemException;
325    
326            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
327            public com.liferay.portlet.asset.model.AssetVocabulary getGroupVocabulary(
328                    long groupId, java.lang.String name)
329                    throws com.liferay.portal.kernel.exception.PortalException,
330                            com.liferay.portal.kernel.exception.SystemException;
331    
332            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
333            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getVocabularies(
334                    long[] vocabularyIds)
335                    throws com.liferay.portal.kernel.exception.PortalException,
336                            com.liferay.portal.kernel.exception.SystemException;
337    
338            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
339            public com.liferay.portlet.asset.model.AssetVocabulary getVocabulary(
340                    long vocabularyId)
341                    throws com.liferay.portal.kernel.exception.PortalException,
342                            com.liferay.portal.kernel.exception.SystemException;
343    
344            /**
345            * @deprecated
346            */
347            public com.liferay.portlet.asset.model.AssetVocabulary updateVocabulary(
348                    long vocabularyId,
349                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
350                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
351                    java.lang.String settings,
352                    com.liferay.portal.service.ServiceContext serviceContext)
353                    throws com.liferay.portal.kernel.exception.PortalException,
354                            com.liferay.portal.kernel.exception.SystemException;
355    
356            public com.liferay.portlet.asset.model.AssetVocabulary updateVocabulary(
357                    long vocabularyId, java.lang.String title,
358                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
359                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
360                    java.lang.String settings,
361                    com.liferay.portal.service.ServiceContext serviceContext)
362                    throws com.liferay.portal.kernel.exception.PortalException,
363                            com.liferay.portal.kernel.exception.SystemException;
364    }