001    /**
002     * Copyright (c) 2000-2010 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.annotation.Isolation;
018    import com.liferay.portal.kernel.annotation.Propagation;
019    import com.liferay.portal.kernel.annotation.Transactional;
020    import com.liferay.portal.kernel.exception.PortalException;
021    import com.liferay.portal.kernel.exception.SystemException;
022    
023    /**
024     * The interface for the asset vocabulary local service.
025     *
026     * <p>
027     * 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.
028     * </p>
029     *
030     * <p>
031     * 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.
032     * </p>
033     *
034     * @author Brian Wing Shun Chan
035     * @see AssetVocabularyLocalServiceUtil
036     * @see com.liferay.portlet.asset.service.base.AssetVocabularyLocalServiceBaseImpl
037     * @see com.liferay.portlet.asset.service.impl.AssetVocabularyLocalServiceImpl
038     * @generated
039     */
040    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
041            PortalException.class, SystemException.class})
042    public interface AssetVocabularyLocalService {
043            /**
044            * Adds the asset vocabulary to the database. Also notifies the appropriate model listeners.
045            *
046            * @param assetVocabulary the asset vocabulary to add
047            * @return the asset vocabulary that was added
048            * @throws SystemException if a system exception occurred
049            */
050            public com.liferay.portlet.asset.model.AssetVocabulary addAssetVocabulary(
051                    com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary)
052                    throws com.liferay.portal.kernel.exception.SystemException;
053    
054            /**
055            * Creates a new asset vocabulary with the primary key. Does not add the asset vocabulary to the database.
056            *
057            * @param vocabularyId the primary key for the new asset vocabulary
058            * @return the new asset vocabulary
059            */
060            public com.liferay.portlet.asset.model.AssetVocabulary createAssetVocabulary(
061                    long vocabularyId);
062    
063            /**
064            * Deletes the asset vocabulary with the primary key from the database. Also notifies the appropriate model listeners.
065            *
066            * @param vocabularyId the primary key of the asset vocabulary to delete
067            * @throws PortalException if a asset vocabulary with the primary key could not be found
068            * @throws SystemException if a system exception occurred
069            */
070            public void deleteAssetVocabulary(long vocabularyId)
071                    throws com.liferay.portal.kernel.exception.PortalException,
072                            com.liferay.portal.kernel.exception.SystemException;
073    
074            /**
075            * Deletes the asset vocabulary from the database. Also notifies the appropriate model listeners.
076            *
077            * @param assetVocabulary the asset vocabulary to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public void deleteAssetVocabulary(
081                    com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary)
082                    throws com.liferay.portal.kernel.exception.SystemException;
083    
084            /**
085            * Performs a dynamic query on the database and returns the matching rows.
086            *
087            * @param dynamicQuery the dynamic query to search with
088            * @return the matching rows
089            * @throws SystemException if a system exception occurred
090            */
091            @SuppressWarnings("rawtypes")
092            public java.util.List dynamicQuery(
093                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
094                    throws com.liferay.portal.kernel.exception.SystemException;
095    
096            /**
097            * Performs a dynamic query on the database and returns a range of the matching rows.
098            *
099            * <p>
100            * 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.
101            * </p>
102            *
103            * @param dynamicQuery the dynamic query to search with
104            * @param start the lower bound of the range of model instances to return
105            * @param end the upper bound of the range of model instances to return (not inclusive)
106            * @return the range of matching rows
107            * @throws SystemException if a system exception occurred
108            */
109            @SuppressWarnings("rawtypes")
110            public java.util.List dynamicQuery(
111                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
112                    int end) throws com.liferay.portal.kernel.exception.SystemException;
113    
114            /**
115            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
116            *
117            * <p>
118            * 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.
119            * </p>
120            *
121            * @param dynamicQuery the dynamic query to search with
122            * @param start the lower bound of the range of model instances to return
123            * @param end the upper bound of the range of model instances to return (not inclusive)
124            * @param orderByComparator the comparator to order the results by
125            * @return the ordered range of matching rows
126            * @throws SystemException if a system exception occurred
127            */
128            @SuppressWarnings("rawtypes")
129            public java.util.List dynamicQuery(
130                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
131                    int end,
132                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
133                    throws com.liferay.portal.kernel.exception.SystemException;
134    
135            /**
136            * Counts the number of rows that match the dynamic query.
137            *
138            * @param dynamicQuery the dynamic query to search with
139            * @return the number of rows that match the dynamic query
140            * @throws SystemException if a system exception occurred
141            */
142            public long dynamicQueryCount(
143                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
144                    throws com.liferay.portal.kernel.exception.SystemException;
145    
146            /**
147            * Gets the asset vocabulary with the primary key.
148            *
149            * @param vocabularyId the primary key of the asset vocabulary to get
150            * @return the asset vocabulary
151            * @throws PortalException if a asset vocabulary with the primary key could not be found
152            * @throws SystemException if a system exception occurred
153            */
154            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
155            public com.liferay.portlet.asset.model.AssetVocabulary getAssetVocabulary(
156                    long vocabularyId)
157                    throws com.liferay.portal.kernel.exception.PortalException,
158                            com.liferay.portal.kernel.exception.SystemException;
159    
160            /**
161            * Gets the asset vocabulary with the UUID and group id.
162            *
163            * @param uuid the UUID of asset vocabulary to get
164            * @param groupId the group id of the asset vocabulary to get
165            * @return the asset vocabulary
166            * @throws PortalException if a asset vocabulary with the UUID and group id 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 getAssetVocabularyByUuidAndGroupId(
171                    java.lang.String uuid, long groupId)
172                    throws com.liferay.portal.kernel.exception.PortalException,
173                            com.liferay.portal.kernel.exception.SystemException;
174    
175            /**
176            * Gets a range of all the asset vocabularies.
177            *
178            * <p>
179            * 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.
180            * </p>
181            *
182            * @param start the lower bound of the range of asset vocabularies to return
183            * @param end the upper bound of the range of asset vocabularies to return (not inclusive)
184            * @return the range of asset vocabularies
185            * @throws SystemException if a system exception occurred
186            */
187            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
188            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getAssetVocabularies(
189                    int start, int end)
190                    throws com.liferay.portal.kernel.exception.SystemException;
191    
192            /**
193            * Gets the number of asset vocabularies.
194            *
195            * @return the number of asset vocabularies
196            * @throws SystemException if a system exception occurred
197            */
198            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
199            public int getAssetVocabulariesCount()
200                    throws com.liferay.portal.kernel.exception.SystemException;
201    
202            /**
203            * Updates the asset vocabulary in the database. Also notifies the appropriate model listeners.
204            *
205            * @param assetVocabulary the asset vocabulary to update
206            * @return the asset vocabulary that was updated
207            * @throws SystemException if a system exception occurred
208            */
209            public com.liferay.portlet.asset.model.AssetVocabulary updateAssetVocabulary(
210                    com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary)
211                    throws com.liferay.portal.kernel.exception.SystemException;
212    
213            /**
214            * Updates the asset vocabulary in the database. Also notifies the appropriate model listeners.
215            *
216            * @param assetVocabulary the asset vocabulary to update
217            * @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.
218            * @return the asset vocabulary that was updated
219            * @throws SystemException if a system exception occurred
220            */
221            public com.liferay.portlet.asset.model.AssetVocabulary updateAssetVocabulary(
222                    com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary,
223                    boolean merge)
224                    throws com.liferay.portal.kernel.exception.SystemException;
225    
226            /**
227            * @deprecated
228            */
229            public com.liferay.portlet.asset.model.AssetVocabulary addVocabulary(
230                    long userId,
231                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
232                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
233                    java.lang.String settings,
234                    com.liferay.portal.service.ServiceContext serviceContext)
235                    throws com.liferay.portal.kernel.exception.PortalException,
236                            com.liferay.portal.kernel.exception.SystemException;
237    
238            public com.liferay.portlet.asset.model.AssetVocabulary addVocabulary(
239                    long userId, java.lang.String title,
240                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
241                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
242                    java.lang.String settings,
243                    com.liferay.portal.service.ServiceContext serviceContext)
244                    throws com.liferay.portal.kernel.exception.PortalException,
245                            com.liferay.portal.kernel.exception.SystemException;
246    
247            public void addVocabularyResources(
248                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary,
249                    boolean addCommunityPermissions, boolean addGuestPermissions)
250                    throws com.liferay.portal.kernel.exception.PortalException,
251                            com.liferay.portal.kernel.exception.SystemException;
252    
253            public void addVocabularyResources(
254                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary,
255                    java.lang.String[] communityPermissions,
256                    java.lang.String[] guestPermissions)
257                    throws com.liferay.portal.kernel.exception.PortalException,
258                            com.liferay.portal.kernel.exception.SystemException;
259    
260            public void deleteVocabulary(
261                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary)
262                    throws com.liferay.portal.kernel.exception.PortalException,
263                            com.liferay.portal.kernel.exception.SystemException;
264    
265            public void deleteVocabulary(long vocabularyId)
266                    throws com.liferay.portal.kernel.exception.PortalException,
267                            com.liferay.portal.kernel.exception.SystemException;
268    
269            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
270            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getCompanyVocabularies(
271                    long companyId)
272                    throws com.liferay.portal.kernel.exception.SystemException;
273    
274            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
275            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupsVocabularies(
276                    long[] groupIds)
277                    throws com.liferay.portal.kernel.exception.PortalException,
278                            com.liferay.portal.kernel.exception.SystemException;
279    
280            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
281            public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupVocabularies(
282                    long groupId)
283                    throws com.liferay.portal.kernel.exception.PortalException,
284                            com.liferay.portal.kernel.exception.SystemException;
285    
286            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
287            public com.liferay.portlet.asset.model.AssetVocabulary getGroupVocabulary(
288                    long groupId, java.lang.String name)
289                    throws com.liferay.portal.kernel.exception.PortalException,
290                            com.liferay.portal.kernel.exception.SystemException;
291    
292            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
293            public com.liferay.portlet.asset.model.AssetVocabulary getVocabulary(
294                    long vocabularyId)
295                    throws com.liferay.portal.kernel.exception.PortalException,
296                            com.liferay.portal.kernel.exception.SystemException;
297    
298            /**
299            * @deprecated
300            */
301            public com.liferay.portlet.asset.model.AssetVocabulary updateVocabulary(
302                    long vocabularyId,
303                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
304                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
305                    java.lang.String settings,
306                    com.liferay.portal.service.ServiceContext serviceContext)
307                    throws com.liferay.portal.kernel.exception.PortalException,
308                            com.liferay.portal.kernel.exception.SystemException;
309    
310            public com.liferay.portlet.asset.model.AssetVocabulary updateVocabulary(
311                    long vocabularyId, java.lang.String title,
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    }