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.portlet.asset.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.transaction.Isolation;
022    import com.liferay.portal.kernel.transaction.Propagation;
023    import com.liferay.portal.kernel.transaction.Transactional;
024    import com.liferay.portal.service.BaseLocalService;
025    import com.liferay.portal.service.PersistedModelLocalService;
026    
027    /**
028     * Provides the local service interface for AssetVocabulary. Methods of this
029     * service will not have security checks based on the propagated JAAS
030     * credentials because this service can only be accessed from within the same
031     * VM.
032     *
033     * @author Brian Wing Shun Chan
034     * @see AssetVocabularyLocalServiceUtil
035     * @see com.liferay.portlet.asset.service.base.AssetVocabularyLocalServiceBaseImpl
036     * @see com.liferay.portlet.asset.service.impl.AssetVocabularyLocalServiceImpl
037     * @generated
038     */
039    @ProviderType
040    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
041            PortalException.class, SystemException.class})
042    public interface AssetVocabularyLocalService extends BaseLocalService,
043            PersistedModelLocalService {
044            /*
045             * NOTE FOR DEVELOPERS:
046             *
047             * 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.
048             */
049    
050            /**
051            * Adds the asset vocabulary to the database. Also notifies the appropriate model listeners.
052            *
053            * @param assetVocabulary the asset vocabulary
054            * @return the asset vocabulary that was added
055            * @throws SystemException if a system exception occurred
056            */
057            public com.liferay.portlet.asset.model.AssetVocabulary addAssetVocabulary(
058                    com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary)
059                    throws com.liferay.portal.kernel.exception.SystemException;
060    
061            /**
062            * Creates a new asset vocabulary with the primary key. Does not add the asset vocabulary to the database.
063            *
064            * @param vocabularyId the primary key for the new asset vocabulary
065            * @return the new asset vocabulary
066            */
067            public com.liferay.portlet.asset.model.AssetVocabulary createAssetVocabulary(
068                    long vocabularyId);
069    
070            /**
071            * Deletes the asset vocabulary with the primary key from the database. Also notifies the appropriate model listeners.
072            *
073            * @param vocabularyId the primary key of the asset vocabulary
074            * @return the asset vocabulary that was removed
075            * @throws PortalException if a asset vocabulary with the primary key could not be found
076            * @throws SystemException if a system exception occurred
077            */
078            public com.liferay.portlet.asset.model.AssetVocabulary deleteAssetVocabulary(
079                    long vocabularyId)
080                    throws com.liferay.portal.kernel.exception.PortalException,
081                            com.liferay.portal.kernel.exception.SystemException;
082    
083            /**
084            * Deletes the asset vocabulary from the database. Also notifies the appropriate model listeners.
085            *
086            * @param assetVocabulary the asset vocabulary
087            * @return the asset vocabulary that was removed
088            * @throws SystemException if a system exception occurred
089            */
090            public com.liferay.portlet.asset.model.AssetVocabulary deleteAssetVocabulary(
091                    com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary)
092                    throws com.liferay.portal.kernel.exception.SystemException;
093    
094            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
095    
096            /**
097            * Performs a dynamic query on the database and returns the matching rows.
098            *
099            * @param dynamicQuery the dynamic query
100            * @return the matching rows
101            * @throws SystemException if a system exception occurred
102            */
103            @SuppressWarnings("rawtypes")
104            public java.util.List dynamicQuery(
105                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
106                    throws com.liferay.portal.kernel.exception.SystemException;
107    
108            /**
109            * Performs a dynamic query on the database and returns a range of the matching rows.
110            *
111            * <p>
112            * 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.portlet.asset.model.impl.AssetVocabularyModelImpl}. 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.
113            * </p>
114            *
115            * @param dynamicQuery the dynamic query
116            * @param start the lower bound of the range of model instances
117            * @param end the upper bound of the range of model instances (not inclusive)
118            * @return the range of matching rows
119            * @throws SystemException if a system exception occurred
120            */
121            @SuppressWarnings("rawtypes")
122            public java.util.List dynamicQuery(
123                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
124                    int end) throws com.liferay.portal.kernel.exception.SystemException;
125    
126            /**
127            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
128            *
129            * <p>
130            * 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.portlet.asset.model.impl.AssetVocabularyModelImpl}. 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.
131            * </p>
132            *
133            * @param dynamicQuery the dynamic query
134            * @param start the lower bound of the range of model instances
135            * @param end the upper bound of the range of model instances (not inclusive)
136            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
137            * @return the ordered range of matching rows
138            * @throws SystemException if a system exception occurred
139            */
140            @SuppressWarnings("rawtypes")
141            public java.util.List dynamicQuery(
142                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
143                    int end,
144                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
145                    throws com.liferay.portal.kernel.exception.SystemException;
146    
147            /**
148            * Returns the number of rows that match the dynamic query.
149            *
150            * @param dynamicQuery the dynamic query
151            * @return the number of rows that match the dynamic query
152            * @throws SystemException if a system exception occurred
153            */
154            public long dynamicQueryCount(
155                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
156                    throws com.liferay.portal.kernel.exception.SystemException;
157    
158            /**
159            * Returns the number of rows that match 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 that match the dynamic query
164            * @throws SystemException if a system exception occurred
165            */
166            public long dynamicQueryCount(
167                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
168                    com.liferay.portal.kernel.dao.orm.Projection projection)
169                    throws com.liferay.portal.kernel.exception.SystemException;
170    
171            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
172            public com.liferay.portlet.asset.model.AssetVocabulary fetchAssetVocabulary(
173                    long vocabularyId)
174                    throws com.liferay.portal.kernel.exception.SystemException;
175    
176            /**
177            * Returns the asset vocabulary with the matching UUID and company.
178            *
179            * @param uuid the asset vocabulary's UUID
180            * @param companyId the primary key of the company
181            * @return the matching asset vocabulary, or <code>null</code> if a matching asset vocabulary could not be found
182            * @throws SystemException if a system exception occurred
183            */
184            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
185            public com.liferay.portlet.asset.model.AssetVocabulary fetchAssetVocabularyByUuidAndCompanyId(
186                    java.lang.String uuid, long companyId)
187                    throws com.liferay.portal.kernel.exception.SystemException;
188    
189            /**
190            * Returns the asset vocabulary matching the UUID and group.
191            *
192            * @param uuid the asset vocabulary's UUID
193            * @param groupId the primary key of the group
194            * @return the matching asset vocabulary, or <code>null</code> if a matching asset vocabulary could not be found
195            * @throws SystemException if a system exception occurred
196            */
197            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
198            public com.liferay.portlet.asset.model.AssetVocabulary fetchAssetVocabularyByUuidAndGroupId(
199                    java.lang.String uuid, long groupId)
200                    throws com.liferay.portal.kernel.exception.SystemException;
201    
202            /**
203            * Returns the asset vocabulary with the primary key.
204            *
205            * @param vocabularyId the primary key of the asset vocabulary
206            * @return the asset vocabulary
207            * @throws PortalException if a asset vocabulary with the primary key could not be found
208            * @throws SystemException if a system exception occurred
209            */
210            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
211            public com.liferay.portlet.asset.model.AssetVocabulary getAssetVocabulary(
212                    long vocabularyId)
213                    throws com.liferay.portal.kernel.exception.PortalException,
214                            com.liferay.portal.kernel.exception.SystemException;
215    
216            @Override
217            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
218            public com.liferay.portal.model.PersistedModel getPersistedModel(
219                    java.io.Serializable primaryKeyObj)
220                    throws com.liferay.portal.kernel.exception.PortalException,
221                            com.liferay.portal.kernel.exception.SystemException;
222    
223            /**
224            * Returns the asset vocabulary with the matching UUID and company.
225            *
226            * @param uuid the asset vocabulary's UUID
227            * @param companyId the primary key of the company
228            * @return the matching asset vocabulary
229            * @throws PortalException if a matching asset vocabulary could not be found
230            * @throws SystemException if a system exception occurred
231            */
232            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
233            public com.liferay.portlet.asset.model.AssetVocabulary getAssetVocabularyByUuidAndCompanyId(
234                    java.lang.String uuid, long companyId)
235                    throws com.liferay.portal.kernel.exception.PortalException,
236                            com.liferay.portal.kernel.exception.SystemException;
237    
238            /**
239            * Returns the asset vocabulary matching the UUID and group.
240            *
241            * @param uuid the asset vocabulary's UUID
242            * @param groupId the primary key of the group
243            * @return the matching asset vocabulary
244            * @throws PortalException if a matching asset vocabulary could not be found
245            * @throws SystemException if a system exception occurred
246            */
247            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
248            public com.liferay.portlet.asset.model.AssetVocabulary getAssetVocabularyByUuidAndGroupId(
249                    java.lang.String uuid, long groupId)
250                    throws com.liferay.portal.kernel.exception.PortalException,
251                            com.liferay.portal.kernel.exception.SystemException;
252    
253            /**
254            * Returns a range of all the asset vocabularies.
255            *
256            * <p>
257            * 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.portlet.asset.model.impl.AssetVocabularyModelImpl}. 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.
258            * </p>
259            *
260            * @param start the lower bound of the range of asset vocabularies
261            * @param end the upper bound of the range of asset vocabularies (not inclusive)
262            * @return the range of asset vocabularies
263            * @throws SystemException if a system exception occurred
264            */
265            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
266            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getAssetVocabularies(
267                    int start, int end)
268                    throws com.liferay.portal.kernel.exception.SystemException;
269    
270            /**
271            * Returns the number of asset vocabularies.
272            *
273            * @return the number of asset vocabularies
274            * @throws SystemException if a system exception occurred
275            */
276            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
277            public int getAssetVocabulariesCount()
278                    throws com.liferay.portal.kernel.exception.SystemException;
279    
280            /**
281            * Updates the asset vocabulary in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
282            *
283            * @param assetVocabulary the asset vocabulary
284            * @return the asset vocabulary that was updated
285            * @throws SystemException if a system exception occurred
286            */
287            public com.liferay.portlet.asset.model.AssetVocabulary updateAssetVocabulary(
288                    com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary)
289                    throws com.liferay.portal.kernel.exception.SystemException;
290    
291            /**
292            * Returns the Spring bean ID for this bean.
293            *
294            * @return the Spring bean ID for this bean
295            */
296            public java.lang.String getBeanIdentifier();
297    
298            /**
299            * Sets the Spring bean ID for this bean.
300            *
301            * @param beanIdentifier the Spring bean ID for this bean
302            */
303            public void setBeanIdentifier(java.lang.String beanIdentifier);
304    
305            public com.liferay.portlet.asset.model.AssetVocabulary addDefaultVocabulary(
306                    long groupId)
307                    throws com.liferay.portal.kernel.exception.PortalException,
308                            com.liferay.portal.kernel.exception.SystemException;
309    
310            /**
311            * @deprecated As of 6.1.0
312            */
313            public com.liferay.portlet.asset.model.AssetVocabulary addVocabulary(
314                    long userId,
315                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
316                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
317                    java.lang.String settings,
318                    com.liferay.portal.service.ServiceContext serviceContext)
319                    throws com.liferay.portal.kernel.exception.PortalException,
320                            com.liferay.portal.kernel.exception.SystemException;
321    
322            public com.liferay.portlet.asset.model.AssetVocabulary addVocabulary(
323                    long userId, java.lang.String title,
324                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
325                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
326                    java.lang.String settings,
327                    com.liferay.portal.service.ServiceContext serviceContext)
328                    throws com.liferay.portal.kernel.exception.PortalException,
329                            com.liferay.portal.kernel.exception.SystemException;
330    
331            public com.liferay.portlet.asset.model.AssetVocabulary addVocabulary(
332                    long userId, java.lang.String title,
333                    com.liferay.portal.service.ServiceContext serviceContext)
334                    throws com.liferay.portal.kernel.exception.PortalException,
335                            com.liferay.portal.kernel.exception.SystemException;
336    
337            public void addVocabularyResources(
338                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary,
339                    boolean addGroupPermissions, boolean addGuestPermissions)
340                    throws com.liferay.portal.kernel.exception.PortalException,
341                            com.liferay.portal.kernel.exception.SystemException;
342    
343            public void addVocabularyResources(
344                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary,
345                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
346                    throws com.liferay.portal.kernel.exception.PortalException,
347                            com.liferay.portal.kernel.exception.SystemException;
348    
349            public void deleteVocabularies(long groupId)
350                    throws com.liferay.portal.kernel.exception.PortalException,
351                            com.liferay.portal.kernel.exception.SystemException;
352    
353            public void deleteVocabulary(
354                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary)
355                    throws com.liferay.portal.kernel.exception.PortalException,
356                            com.liferay.portal.kernel.exception.SystemException;
357    
358            public void deleteVocabulary(long vocabularyId)
359                    throws com.liferay.portal.kernel.exception.PortalException,
360                            com.liferay.portal.kernel.exception.SystemException;
361    
362            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
363            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getCompanyVocabularies(
364                    long companyId)
365                    throws com.liferay.portal.kernel.exception.SystemException;
366    
367            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
368            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupsVocabularies(
369                    long[] groupIds)
370                    throws com.liferay.portal.kernel.exception.PortalException,
371                            com.liferay.portal.kernel.exception.SystemException;
372    
373            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
374            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupsVocabularies(
375                    long[] groupIds, java.lang.String className)
376                    throws com.liferay.portal.kernel.exception.PortalException,
377                            com.liferay.portal.kernel.exception.SystemException;
378    
379            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
380            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupVocabularies(
381                    long groupId)
382                    throws com.liferay.portal.kernel.exception.PortalException,
383                            com.liferay.portal.kernel.exception.SystemException;
384    
385            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
386            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupVocabularies(
387                    long groupId, boolean addDefaultVocabulary)
388                    throws com.liferay.portal.kernel.exception.PortalException,
389                            com.liferay.portal.kernel.exception.SystemException;
390    
391            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
392            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupVocabularies(
393                    long groupId, java.lang.String name, int start, int end,
394                    com.liferay.portal.kernel.util.OrderByComparator obc)
395                    throws com.liferay.portal.kernel.exception.SystemException;
396    
397            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
398            public com.liferay.portlet.asset.model.AssetVocabulary getGroupVocabulary(
399                    long groupId, java.lang.String name)
400                    throws com.liferay.portal.kernel.exception.PortalException,
401                            com.liferay.portal.kernel.exception.SystemException;
402    
403            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
404            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getVocabularies(
405                    long[] vocabularyIds)
406                    throws com.liferay.portal.kernel.exception.PortalException,
407                            com.liferay.portal.kernel.exception.SystemException;
408    
409            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
410            public com.liferay.portlet.asset.model.AssetVocabulary getVocabulary(
411                    long vocabularyId)
412                    throws com.liferay.portal.kernel.exception.PortalException,
413                            com.liferay.portal.kernel.exception.SystemException;
414    
415            /**
416            * @deprecated As of 6.1.0
417            */
418            public com.liferay.portlet.asset.model.AssetVocabulary updateVocabulary(
419                    long vocabularyId,
420                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
421                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
422                    java.lang.String settings,
423                    com.liferay.portal.service.ServiceContext serviceContext)
424                    throws com.liferay.portal.kernel.exception.PortalException,
425                            com.liferay.portal.kernel.exception.SystemException;
426    
427            public com.liferay.portlet.asset.model.AssetVocabulary updateVocabulary(
428                    long vocabularyId, java.lang.String title,
429                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
430                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
431                    java.lang.String settings,
432                    com.liferay.portal.service.ServiceContext serviceContext)
433                    throws com.liferay.portal.kernel.exception.PortalException,
434                            com.liferay.portal.kernel.exception.SystemException;
435    }