001    /**
002     * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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     * The interface for the asset vocabulary local service.
027     *
028     * <p>
029     * 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.
030     * </p>
031     *
032     * @author Brian Wing Shun Chan
033     * @see AssetVocabularyLocalServiceUtil
034     * @see com.liferay.portlet.asset.service.base.AssetVocabularyLocalServiceBaseImpl
035     * @see com.liferay.portlet.asset.service.impl.AssetVocabularyLocalServiceImpl
036     * @generated
037     */
038    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
039            PortalException.class, SystemException.class})
040    public interface AssetVocabularyLocalService extends BaseLocalService,
041            PersistedModelLocalService {
042            /*
043             * NOTE FOR DEVELOPERS:
044             *
045             * 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.
046             */
047    
048            /**
049            * Adds the asset vocabulary to the database. Also notifies the appropriate model listeners.
050            *
051            * @param assetVocabulary the asset vocabulary
052            * @return the asset vocabulary that was added
053            * @throws SystemException if a system exception occurred
054            */
055            public com.liferay.portlet.asset.model.AssetVocabulary addAssetVocabulary(
056                    com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary)
057                    throws com.liferay.portal.kernel.exception.SystemException;
058    
059            /**
060            * Creates a new asset vocabulary with the primary key. Does not add the asset vocabulary to the database.
061            *
062            * @param vocabularyId the primary key for the new asset vocabulary
063            * @return the new asset vocabulary
064            */
065            public com.liferay.portlet.asset.model.AssetVocabulary createAssetVocabulary(
066                    long vocabularyId);
067    
068            /**
069            * Deletes the asset vocabulary with the primary key from the database. Also notifies the appropriate model listeners.
070            *
071            * @param vocabularyId the primary key of the asset vocabulary
072            * @return the asset vocabulary that was removed
073            * @throws PortalException if a asset vocabulary with the primary key could not be found
074            * @throws SystemException if a system exception occurred
075            */
076            public com.liferay.portlet.asset.model.AssetVocabulary deleteAssetVocabulary(
077                    long vocabularyId)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException;
080    
081            /**
082            * Deletes the asset vocabulary from the database. Also notifies the appropriate model listeners.
083            *
084            * @param assetVocabulary the asset vocabulary
085            * @return the asset vocabulary that was removed
086            * @throws SystemException if a system exception occurred
087            */
088            public com.liferay.portlet.asset.model.AssetVocabulary deleteAssetVocabulary(
089                    com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary)
090                    throws com.liferay.portal.kernel.exception.SystemException;
091    
092            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
093    
094            /**
095            * Performs a dynamic query on the database and returns the matching rows.
096            *
097            * @param dynamicQuery the dynamic query
098            * @return the matching rows
099            * @throws SystemException if a system exception occurred
100            */
101            @SuppressWarnings("rawtypes")
102            public java.util.List dynamicQuery(
103                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
104                    throws com.liferay.portal.kernel.exception.SystemException;
105    
106            /**
107            * Performs a dynamic query on the database and returns a range of the matching rows.
108            *
109            * <p>
110            * 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.
111            * </p>
112            *
113            * @param dynamicQuery the dynamic query
114            * @param start the lower bound of the range of model instances
115            * @param end the upper bound of the range of model instances (not inclusive)
116            * @return the range of matching rows
117            * @throws SystemException if a system exception occurred
118            */
119            @SuppressWarnings("rawtypes")
120            public java.util.List dynamicQuery(
121                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
122                    int end) throws com.liferay.portal.kernel.exception.SystemException;
123    
124            /**
125            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
126            *
127            * <p>
128            * 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.
129            * </p>
130            *
131            * @param dynamicQuery the dynamic query
132            * @param start the lower bound of the range of model instances
133            * @param end the upper bound of the range of model instances (not inclusive)
134            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
135            * @return the ordered range of matching rows
136            * @throws SystemException if a system exception occurred
137            */
138            @SuppressWarnings("rawtypes")
139            public java.util.List dynamicQuery(
140                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
141                    int end,
142                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
143                    throws com.liferay.portal.kernel.exception.SystemException;
144    
145            /**
146            * Returns the number of rows that match the dynamic query.
147            *
148            * @param dynamicQuery the dynamic query
149            * @return the number of rows that match the dynamic query
150            * @throws SystemException if a system exception occurred
151            */
152            public long dynamicQueryCount(
153                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
154                    throws com.liferay.portal.kernel.exception.SystemException;
155    
156            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
157            public com.liferay.portlet.asset.model.AssetVocabulary fetchAssetVocabulary(
158                    long vocabularyId)
159                    throws com.liferay.portal.kernel.exception.SystemException;
160    
161            /**
162            * Returns the asset vocabulary with the primary key.
163            *
164            * @param vocabularyId the primary key of the asset vocabulary
165            * @return the asset vocabulary
166            * @throws PortalException if a asset vocabulary with the primary key could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
170            public com.liferay.portlet.asset.model.AssetVocabulary getAssetVocabulary(
171                    long vocabularyId)
172                    throws com.liferay.portal.kernel.exception.PortalException,
173                            com.liferay.portal.kernel.exception.SystemException;
174    
175            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
176            public com.liferay.portal.model.PersistedModel getPersistedModel(
177                    java.io.Serializable primaryKeyObj)
178                    throws com.liferay.portal.kernel.exception.PortalException,
179                            com.liferay.portal.kernel.exception.SystemException;
180    
181            /**
182            * Returns the asset vocabulary with the UUID in the group.
183            *
184            * @param uuid the UUID of asset vocabulary
185            * @param groupId the group id of the asset vocabulary
186            * @return the asset vocabulary
187            * @throws PortalException if a asset vocabulary with the UUID in the group could not be found
188            * @throws SystemException if a system exception occurred
189            */
190            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
191            public com.liferay.portlet.asset.model.AssetVocabulary getAssetVocabularyByUuidAndGroupId(
192                    java.lang.String uuid, long groupId)
193                    throws com.liferay.portal.kernel.exception.PortalException,
194                            com.liferay.portal.kernel.exception.SystemException;
195    
196            /**
197            * Returns a range of all the asset vocabularies.
198            *
199            * <p>
200            * 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.
201            * </p>
202            *
203            * @param start the lower bound of the range of asset vocabularies
204            * @param end the upper bound of the range of asset vocabularies (not inclusive)
205            * @return the range of asset vocabularies
206            * @throws SystemException if a system exception occurred
207            */
208            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
209            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getAssetVocabularies(
210                    int start, int end)
211                    throws com.liferay.portal.kernel.exception.SystemException;
212    
213            /**
214            * Returns the number of asset vocabularies.
215            *
216            * @return the number of asset vocabularies
217            * @throws SystemException if a system exception occurred
218            */
219            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
220            public int getAssetVocabulariesCount()
221                    throws com.liferay.portal.kernel.exception.SystemException;
222    
223            /**
224            * Updates the asset vocabulary in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
225            *
226            * @param assetVocabulary the asset vocabulary
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                    throws com.liferay.portal.kernel.exception.SystemException;
233    
234            /**
235            * Updates the asset vocabulary in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
236            *
237            * @param assetVocabulary the asset vocabulary
238            * @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.
239            * @return the asset vocabulary that was updated
240            * @throws SystemException if a system exception occurred
241            */
242            public com.liferay.portlet.asset.model.AssetVocabulary updateAssetVocabulary(
243                    com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary,
244                    boolean merge)
245                    throws com.liferay.portal.kernel.exception.SystemException;
246    
247            /**
248            * Returns the Spring bean ID for this bean.
249            *
250            * @return the Spring bean ID for this bean
251            */
252            public java.lang.String getBeanIdentifier();
253    
254            /**
255            * Sets the Spring bean ID for this bean.
256            *
257            * @param beanIdentifier the Spring bean ID for this bean
258            */
259            public void setBeanIdentifier(java.lang.String beanIdentifier);
260    
261            /**
262            * @deprecated
263            */
264            public com.liferay.portlet.asset.model.AssetVocabulary addVocabulary(
265                    long userId,
266                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
267                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
268                    java.lang.String settings,
269                    com.liferay.portal.service.ServiceContext serviceContext)
270                    throws com.liferay.portal.kernel.exception.PortalException,
271                            com.liferay.portal.kernel.exception.SystemException;
272    
273            public com.liferay.portlet.asset.model.AssetVocabulary addVocabulary(
274                    long userId, java.lang.String title,
275                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
276                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
277                    java.lang.String settings,
278                    com.liferay.portal.service.ServiceContext serviceContext)
279                    throws com.liferay.portal.kernel.exception.PortalException,
280                            com.liferay.portal.kernel.exception.SystemException;
281    
282            public void addVocabularyResources(
283                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary,
284                    boolean addGroupPermissions, boolean addGuestPermissions)
285                    throws com.liferay.portal.kernel.exception.PortalException,
286                            com.liferay.portal.kernel.exception.SystemException;
287    
288            public void addVocabularyResources(
289                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary,
290                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
291                    throws com.liferay.portal.kernel.exception.PortalException,
292                            com.liferay.portal.kernel.exception.SystemException;
293    
294            public void deleteVocabularies(long groupId)
295                    throws com.liferay.portal.kernel.exception.PortalException,
296                            com.liferay.portal.kernel.exception.SystemException;
297    
298            public void deleteVocabulary(
299                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary)
300                    throws com.liferay.portal.kernel.exception.PortalException,
301                            com.liferay.portal.kernel.exception.SystemException;
302    
303            public void deleteVocabulary(long vocabularyId)
304                    throws com.liferay.portal.kernel.exception.PortalException,
305                            com.liferay.portal.kernel.exception.SystemException;
306    
307            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
308            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getCompanyVocabularies(
309                    long companyId)
310                    throws com.liferay.portal.kernel.exception.SystemException;
311    
312            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
313            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupsVocabularies(
314                    long[] groupIds)
315                    throws com.liferay.portal.kernel.exception.PortalException,
316                            com.liferay.portal.kernel.exception.SystemException;
317    
318            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
319            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupsVocabularies(
320                    long[] groupIds, java.lang.String className)
321                    throws com.liferay.portal.kernel.exception.PortalException,
322                            com.liferay.portal.kernel.exception.SystemException;
323    
324            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
325            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupVocabularies(
326                    long groupId)
327                    throws com.liferay.portal.kernel.exception.PortalException,
328                            com.liferay.portal.kernel.exception.SystemException;
329    
330            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
331            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupVocabularies(
332                    long groupId, boolean createDefaultVocabulary)
333                    throws com.liferay.portal.kernel.exception.PortalException,
334                            com.liferay.portal.kernel.exception.SystemException;
335    
336            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
337            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupVocabularies(
338                    long groupId, java.lang.String name, int start, int end,
339                    com.liferay.portal.kernel.util.OrderByComparator obc)
340                    throws com.liferay.portal.kernel.exception.SystemException;
341    
342            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
343            public com.liferay.portlet.asset.model.AssetVocabulary getGroupVocabulary(
344                    long groupId, java.lang.String name)
345                    throws com.liferay.portal.kernel.exception.PortalException,
346                            com.liferay.portal.kernel.exception.SystemException;
347    
348            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
349            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getVocabularies(
350                    long[] vocabularyIds)
351                    throws com.liferay.portal.kernel.exception.PortalException,
352                            com.liferay.portal.kernel.exception.SystemException;
353    
354            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
355            public com.liferay.portlet.asset.model.AssetVocabulary getVocabulary(
356                    long vocabularyId)
357                    throws com.liferay.portal.kernel.exception.PortalException,
358                            com.liferay.portal.kernel.exception.SystemException;
359    
360            /**
361            * @deprecated
362            */
363            public com.liferay.portlet.asset.model.AssetVocabulary updateVocabulary(
364                    long vocabularyId,
365                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
366                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
367                    java.lang.String settings,
368                    com.liferay.portal.service.ServiceContext serviceContext)
369                    throws com.liferay.portal.kernel.exception.PortalException,
370                            com.liferay.portal.kernel.exception.SystemException;
371    
372            public com.liferay.portlet.asset.model.AssetVocabulary updateVocabulary(
373                    long vocabularyId, java.lang.String title,
374                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
375                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
376                    java.lang.String settings,
377                    com.liferay.portal.service.ServiceContext serviceContext)
378                    throws com.liferay.portal.kernel.exception.PortalException,
379                            com.liferay.portal.kernel.exception.SystemException;
380    }