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