001    /**
002     * Copyright (c) 2000-2011 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.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            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
150            public com.liferay.portlet.asset.model.AssetVocabulary fetchAssetVocabulary(
151                    long vocabularyId)
152                    throws com.liferay.portal.kernel.exception.SystemException;
153    
154            /**
155            * Returns the asset vocabulary with the primary key.
156            *
157            * @param vocabularyId the primary key of the asset vocabulary
158            * @return the asset vocabulary
159            * @throws PortalException if a asset vocabulary with the primary key could not be found
160            * @throws SystemException if a system exception occurred
161            */
162            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
163            public com.liferay.portlet.asset.model.AssetVocabulary getAssetVocabulary(
164                    long vocabularyId)
165                    throws com.liferay.portal.kernel.exception.PortalException,
166                            com.liferay.portal.kernel.exception.SystemException;
167    
168            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
169            public com.liferay.portal.model.PersistedModel getPersistedModel(
170                    java.io.Serializable primaryKeyObj)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException;
173    
174            /**
175            * Returns the asset vocabulary with the UUID in the group.
176            *
177            * @param uuid the UUID of asset vocabulary
178            * @param groupId the group id of the asset vocabulary
179            * @return the asset vocabulary
180            * @throws PortalException if a asset vocabulary with the UUID in the group could not be found
181            * @throws SystemException if a system exception occurred
182            */
183            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
184            public com.liferay.portlet.asset.model.AssetVocabulary getAssetVocabularyByUuidAndGroupId(
185                    java.lang.String uuid, long groupId)
186                    throws com.liferay.portal.kernel.exception.PortalException,
187                            com.liferay.portal.kernel.exception.SystemException;
188    
189            /**
190            * Returns a range of all the asset vocabularies.
191            *
192            * <p>
193            * 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.
194            * </p>
195            *
196            * @param start the lower bound of the range of asset vocabularies
197            * @param end the upper bound of the range of asset vocabularies (not inclusive)
198            * @return the range of asset vocabularies
199            * @throws SystemException if a system exception occurred
200            */
201            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
202            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getAssetVocabularies(
203                    int start, int end)
204                    throws com.liferay.portal.kernel.exception.SystemException;
205    
206            /**
207            * Returns the number of asset vocabularies.
208            *
209            * @return the number of asset vocabularies
210            * @throws SystemException if a system exception occurred
211            */
212            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
213            public int getAssetVocabulariesCount()
214                    throws com.liferay.portal.kernel.exception.SystemException;
215    
216            /**
217            * Updates the asset vocabulary in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
218            *
219            * @param assetVocabulary the asset vocabulary
220            * @return the asset vocabulary that was updated
221            * @throws SystemException if a system exception occurred
222            */
223            public com.liferay.portlet.asset.model.AssetVocabulary updateAssetVocabulary(
224                    com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary)
225                    throws com.liferay.portal.kernel.exception.SystemException;
226    
227            /**
228            * Updates the asset vocabulary in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
229            *
230            * @param assetVocabulary the asset vocabulary
231            * @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.
232            * @return the asset vocabulary that was updated
233            * @throws SystemException if a system exception occurred
234            */
235            public com.liferay.portlet.asset.model.AssetVocabulary updateAssetVocabulary(
236                    com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary,
237                    boolean merge)
238                    throws com.liferay.portal.kernel.exception.SystemException;
239    
240            /**
241            * Returns the Spring bean ID for this bean.
242            *
243            * @return the Spring bean ID for this bean
244            */
245            public java.lang.String getBeanIdentifier();
246    
247            /**
248            * Sets the Spring bean ID for this bean.
249            *
250            * @param beanIdentifier the Spring bean ID for this bean
251            */
252            public void setBeanIdentifier(java.lang.String beanIdentifier);
253    
254            /**
255            * @deprecated
256            */
257            public com.liferay.portlet.asset.model.AssetVocabulary addVocabulary(
258                    long userId,
259                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
260                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
261                    java.lang.String settings,
262                    com.liferay.portal.service.ServiceContext serviceContext)
263                    throws com.liferay.portal.kernel.exception.PortalException,
264                            com.liferay.portal.kernel.exception.SystemException;
265    
266            public com.liferay.portlet.asset.model.AssetVocabulary addVocabulary(
267                    long userId, java.lang.String title,
268                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
269                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
270                    java.lang.String settings,
271                    com.liferay.portal.service.ServiceContext serviceContext)
272                    throws com.liferay.portal.kernel.exception.PortalException,
273                            com.liferay.portal.kernel.exception.SystemException;
274    
275            public void addVocabularyResources(
276                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary,
277                    boolean addGroupPermissions, boolean addGuestPermissions)
278                    throws com.liferay.portal.kernel.exception.PortalException,
279                            com.liferay.portal.kernel.exception.SystemException;
280    
281            public void addVocabularyResources(
282                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary,
283                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
284                    throws com.liferay.portal.kernel.exception.PortalException,
285                            com.liferay.portal.kernel.exception.SystemException;
286    
287            public void deleteVocabulary(
288                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary)
289                    throws com.liferay.portal.kernel.exception.PortalException,
290                            com.liferay.portal.kernel.exception.SystemException;
291    
292            public void deleteVocabulary(long vocabularyId)
293                    throws com.liferay.portal.kernel.exception.PortalException,
294                            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> getCompanyVocabularies(
298                    long companyId)
299                    throws com.liferay.portal.kernel.exception.SystemException;
300    
301            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
302            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupsVocabularies(
303                    long[] groupIds)
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> getGroupsVocabularies(
309                    long[] groupIds, java.lang.String className)
310                    throws com.liferay.portal.kernel.exception.PortalException,
311                            com.liferay.portal.kernel.exception.SystemException;
312    
313            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
314            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupVocabularies(
315                    long groupId)
316                    throws com.liferay.portal.kernel.exception.PortalException,
317                            com.liferay.portal.kernel.exception.SystemException;
318    
319            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
320            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupVocabularies(
321                    long groupId, boolean createDefaultVocabulary)
322                    throws com.liferay.portal.kernel.exception.PortalException,
323                            com.liferay.portal.kernel.exception.SystemException;
324    
325            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
326            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupVocabularies(
327                    long groupId, java.lang.String name, int start, int end,
328                    com.liferay.portal.kernel.util.OrderByComparator obc)
329                    throws com.liferay.portal.kernel.exception.SystemException;
330    
331            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
332            public com.liferay.portlet.asset.model.AssetVocabulary getGroupVocabulary(
333                    long groupId, java.lang.String name)
334                    throws com.liferay.portal.kernel.exception.PortalException,
335                            com.liferay.portal.kernel.exception.SystemException;
336    
337            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
338            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getVocabularies(
339                    long[] vocabularyIds)
340                    throws com.liferay.portal.kernel.exception.PortalException,
341                            com.liferay.portal.kernel.exception.SystemException;
342    
343            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
344            public com.liferay.portlet.asset.model.AssetVocabulary getVocabulary(
345                    long vocabularyId)
346                    throws com.liferay.portal.kernel.exception.PortalException,
347                            com.liferay.portal.kernel.exception.SystemException;
348    
349            /**
350            * @deprecated
351            */
352            public com.liferay.portlet.asset.model.AssetVocabulary updateVocabulary(
353                    long vocabularyId,
354                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
355                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
356                    java.lang.String settings,
357                    com.liferay.portal.service.ServiceContext serviceContext)
358                    throws com.liferay.portal.kernel.exception.PortalException,
359                            com.liferay.portal.kernel.exception.SystemException;
360    
361            public com.liferay.portlet.asset.model.AssetVocabulary updateVocabulary(
362                    long vocabularyId, java.lang.String title,
363                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
364                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
365                    java.lang.String settings,
366                    com.liferay.portal.service.ServiceContext serviceContext)
367                    throws com.liferay.portal.kernel.exception.PortalException,
368                            com.liferay.portal.kernel.exception.SystemException;
369    }