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     * The interface for the asset tag property 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 AssetTagPropertyLocalServiceUtil
034     * @see com.liferay.portlet.asset.service.base.AssetTagPropertyLocalServiceBaseImpl
035     * @see com.liferay.portlet.asset.service.impl.AssetTagPropertyLocalServiceImpl
036     * @generated
037     */
038    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
039            PortalException.class, SystemException.class})
040    public interface AssetTagPropertyLocalService extends BaseLocalService,
041            PersistedModelLocalService {
042            /*
043             * NOTE FOR DEVELOPERS:
044             *
045             * Never modify or reference this interface directly. Always use {@link AssetTagPropertyLocalServiceUtil} to access the asset tag property local service. Add custom service methods to {@link com.liferay.portlet.asset.service.impl.AssetTagPropertyLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
046             */
047    
048            /**
049            * Adds the asset tag property to the database. Also notifies the appropriate model listeners.
050            *
051            * @param assetTagProperty the asset tag property
052            * @return the asset tag property that was added
053            * @throws SystemException if a system exception occurred
054            */
055            public com.liferay.portlet.asset.model.AssetTagProperty addAssetTagProperty(
056                    com.liferay.portlet.asset.model.AssetTagProperty assetTagProperty)
057                    throws com.liferay.portal.kernel.exception.SystemException;
058    
059            /**
060            * Creates a new asset tag property with the primary key. Does not add the asset tag property to the database.
061            *
062            * @param tagPropertyId the primary key for the new asset tag property
063            * @return the new asset tag property
064            */
065            public com.liferay.portlet.asset.model.AssetTagProperty createAssetTagProperty(
066                    long tagPropertyId);
067    
068            /**
069            * Deletes the asset tag property with the primary key from the database. Also notifies the appropriate model listeners.
070            *
071            * @param tagPropertyId the primary key of the asset tag property
072            * @return the asset tag property that was removed
073            * @throws PortalException if a asset tag property with the primary key could not be found
074            * @throws SystemException if a system exception occurred
075            */
076            public com.liferay.portlet.asset.model.AssetTagProperty deleteAssetTagProperty(
077                    long tagPropertyId)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException;
080    
081            /**
082            * Deletes the asset tag property from the database. Also notifies the appropriate model listeners.
083            *
084            * @param assetTagProperty the asset tag property
085            * @return the asset tag property that was removed
086            * @throws SystemException if a system exception occurred
087            */
088            public com.liferay.portlet.asset.model.AssetTagProperty deleteAssetTagProperty(
089                    com.liferay.portlet.asset.model.AssetTagProperty assetTagProperty)
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.AssetTagProperty fetchAssetTagProperty(
158                    long tagPropertyId)
159                    throws com.liferay.portal.kernel.exception.SystemException;
160    
161            /**
162            * Returns the asset tag property with the primary key.
163            *
164            * @param tagPropertyId the primary key of the asset tag property
165            * @return the asset tag property
166            * @throws PortalException if a asset tag property 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.AssetTagProperty getAssetTagProperty(
171                    long tagPropertyId)
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 a range of all the asset tag properties.
183            *
184            * <p>
185            * 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.
186            * </p>
187            *
188            * @param start the lower bound of the range of asset tag properties
189            * @param end the upper bound of the range of asset tag properties (not inclusive)
190            * @return the range of asset tag properties
191            * @throws SystemException if a system exception occurred
192            */
193            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
194            public java.util.List<com.liferay.portlet.asset.model.AssetTagProperty> getAssetTagProperties(
195                    int start, int end)
196                    throws com.liferay.portal.kernel.exception.SystemException;
197    
198            /**
199            * Returns the number of asset tag properties.
200            *
201            * @return the number of asset tag properties
202            * @throws SystemException if a system exception occurred
203            */
204            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
205            public int getAssetTagPropertiesCount()
206                    throws com.liferay.portal.kernel.exception.SystemException;
207    
208            /**
209            * Updates the asset tag property in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
210            *
211            * @param assetTagProperty the asset tag property
212            * @return the asset tag property that was updated
213            * @throws SystemException if a system exception occurred
214            */
215            public com.liferay.portlet.asset.model.AssetTagProperty updateAssetTagProperty(
216                    com.liferay.portlet.asset.model.AssetTagProperty assetTagProperty)
217                    throws com.liferay.portal.kernel.exception.SystemException;
218    
219            /**
220            * Updates the asset tag property in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
221            *
222            * @param assetTagProperty the asset tag property
223            * @param merge whether to merge the asset tag property 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.
224            * @return the asset tag property that was updated
225            * @throws SystemException if a system exception occurred
226            */
227            public com.liferay.portlet.asset.model.AssetTagProperty updateAssetTagProperty(
228                    com.liferay.portlet.asset.model.AssetTagProperty assetTagProperty,
229                    boolean merge)
230                    throws com.liferay.portal.kernel.exception.SystemException;
231    
232            /**
233            * Returns the Spring bean ID for this bean.
234            *
235            * @return the Spring bean ID for this bean
236            */
237            public java.lang.String getBeanIdentifier();
238    
239            /**
240            * Sets the Spring bean ID for this bean.
241            *
242            * @param beanIdentifier the Spring bean ID for this bean
243            */
244            public void setBeanIdentifier(java.lang.String beanIdentifier);
245    
246            /**
247            * Adds an asset tag property.
248            *
249            * @param userId the primary key of the user
250            * @param tagId the primary key of the tag
251            * @param key the key to be associated to the value
252            * @param value the value to which the key will refer
253            * @return the created asset tag property
254            * @throws PortalException if a user with the primary key could not be
255            found, or if the key or value were invalid
256            * @throws SystemException if a system exception occurred
257            */
258            public com.liferay.portlet.asset.model.AssetTagProperty addTagProperty(
259                    long userId, long tagId, java.lang.String key, java.lang.String value)
260                    throws com.liferay.portal.kernel.exception.PortalException,
261                            com.liferay.portal.kernel.exception.SystemException;
262    
263            /**
264            * Deletes the asset tag property with the specified tag ID.
265            *
266            * @param tagId the primary key of the tag
267            * @throws SystemException if a system exception occurred
268            */
269            public void deleteTagProperties(long tagId)
270                    throws com.liferay.portal.kernel.exception.SystemException;
271    
272            /**
273            * Deletes the asset tag property instance.
274            *
275            * @param tagProperty the asset tag property instance
276            * @throws SystemException if a system exception occurred
277            */
278            public void deleteTagProperty(
279                    com.liferay.portlet.asset.model.AssetTagProperty tagProperty)
280                    throws com.liferay.portal.kernel.exception.SystemException;
281    
282            /**
283            * Deletes the asset tag property with the specified ID.
284            *
285            * @param tagPropertyId the primary key of the asset tag property instance
286            * @throws PortalException if an asset tag property with the primary key
287            could not be found
288            * @throws SystemException if a system exception occurred
289            */
290            public void deleteTagProperty(long tagPropertyId)
291                    throws com.liferay.portal.kernel.exception.PortalException,
292                            com.liferay.portal.kernel.exception.SystemException;
293    
294            /**
295            * Returns all the asset tag property instances.
296            *
297            * @return the asset tag property instances
298            * @throws SystemException if a system exception occurred
299            */
300            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
301            public java.util.List<com.liferay.portlet.asset.model.AssetTagProperty> getTagProperties()
302                    throws com.liferay.portal.kernel.exception.SystemException;
303    
304            /**
305            * Returns all the asset tag property instances with the specified tag ID.
306            *
307            * @param tagId the primary key of the tag
308            * @return the matching asset tag properties
309            * @throws SystemException if a system exception occurred
310            */
311            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
312            public java.util.List<com.liferay.portlet.asset.model.AssetTagProperty> getTagProperties(
313                    long tagId) throws com.liferay.portal.kernel.exception.SystemException;
314    
315            /**
316            * Returns the asset tag property with the specified ID.
317            *
318            * @param tagPropertyId the primary key of the asset tag property
319            * @return the matching asset tag property
320            * @throws PortalException if an asset tag property with the primary key
321            could not be found
322            * @throws SystemException if a system exception occurred
323            */
324            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
325            public com.liferay.portlet.asset.model.AssetTagProperty getTagProperty(
326                    long tagPropertyId)
327                    throws com.liferay.portal.kernel.exception.PortalException,
328                            com.liferay.portal.kernel.exception.SystemException;
329    
330            /**
331            * Returns the asset tag property with the specified tag ID and key.
332            *
333            * @param tagId the primary key of the tag
334            * @param key the key that refers to some value
335            * @return the matching asset tag property
336            * @throws PortalException if an asset tag property with the tag ID and key
337            could not be found
338            * @throws SystemException if a system exception occurred
339            */
340            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
341            public com.liferay.portlet.asset.model.AssetTagProperty getTagProperty(
342                    long tagId, java.lang.String key)
343                    throws com.liferay.portal.kernel.exception.PortalException,
344                            com.liferay.portal.kernel.exception.SystemException;
345    
346            /**
347            * Returns asset tag property keys with the specified group
348            *
349            * @param groupId the primary key of the group
350            * @return the matching asset tag property keys
351            * @throws SystemException if a system exception occurred
352            */
353            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
354            public java.lang.String[] getTagPropertyKeys(long groupId)
355                    throws com.liferay.portal.kernel.exception.SystemException;
356    
357            /**
358            * Returns asset tag properties with the specified group and key.
359            *
360            * @param groupId the primary key of the group
361            * @param key the key that refers to some value
362            * @return the matching asset tag properties
363            * @throws SystemException if a system exception occurred
364            */
365            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
366            public java.util.List<com.liferay.portlet.asset.model.AssetTagProperty> getTagPropertyValues(
367                    long groupId, java.lang.String key)
368                    throws com.liferay.portal.kernel.exception.SystemException;
369    
370            /**
371            * Updates the asset tag property.
372            *
373            * @param tagPropertyId the primary key of the asset tag property
374            * @param key the new key to be associated to the value
375            * @param value the new value to which the key will refer
376            * @return the updated asset tag property
377            * @throws PortalException if an asset tag property with the primary key
378            could not be found, or if the key or value were invalid
379            * @throws SystemException if a system exception occurred
380            */
381            public com.liferay.portlet.asset.model.AssetTagProperty updateTagProperty(
382                    long tagPropertyId, java.lang.String key, java.lang.String value)
383                    throws com.liferay.portal.kernel.exception.PortalException,
384                            com.liferay.portal.kernel.exception.SystemException;
385    }