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 aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.exception.PortalException;
020    import com.liferay.portal.kernel.exception.SystemException;
021    import com.liferay.portal.kernel.transaction.Isolation;
022    import com.liferay.portal.kernel.transaction.Propagation;
023    import com.liferay.portal.kernel.transaction.Transactional;
024    import com.liferay.portal.service.BaseLocalService;
025    import com.liferay.portal.service.PersistedModelLocalService;
026    
027    /**
028     * Provides the local service interface for AssetTagProperty. Methods of this
029     * service will not have security checks based on the propagated JAAS
030     * credentials because this service can only be accessed from within the same
031     * VM.
032     *
033     * @author Brian Wing Shun Chan
034     * @see AssetTagPropertyLocalServiceUtil
035     * @see com.liferay.portlet.asset.service.base.AssetTagPropertyLocalServiceBaseImpl
036     * @see com.liferay.portlet.asset.service.impl.AssetTagPropertyLocalServiceImpl
037     * @generated
038     */
039    @ProviderType
040    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
041            PortalException.class, SystemException.class})
042    public interface AssetTagPropertyLocalService extends BaseLocalService,
043            PersistedModelLocalService {
044            /*
045             * NOTE FOR DEVELOPERS:
046             *
047             * 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.
048             */
049    
050            /**
051            * Adds the asset tag property to the database. Also notifies the appropriate model listeners.
052            *
053            * @param assetTagProperty the asset tag property
054            * @return the asset tag property that was added
055            * @throws SystemException if a system exception occurred
056            */
057            public com.liferay.portlet.asset.model.AssetTagProperty addAssetTagProperty(
058                    com.liferay.portlet.asset.model.AssetTagProperty assetTagProperty)
059                    throws com.liferay.portal.kernel.exception.SystemException;
060    
061            /**
062            * Creates a new asset tag property with the primary key. Does not add the asset tag property to the database.
063            *
064            * @param tagPropertyId the primary key for the new asset tag property
065            * @return the new asset tag property
066            */
067            public com.liferay.portlet.asset.model.AssetTagProperty createAssetTagProperty(
068                    long tagPropertyId);
069    
070            /**
071            * Deletes the asset tag property with the primary key from the database. Also notifies the appropriate model listeners.
072            *
073            * @param tagPropertyId the primary key of the asset tag property
074            * @return the asset tag property that was removed
075            * @throws PortalException if a asset tag property with the primary key could not be found
076            * @throws SystemException if a system exception occurred
077            */
078            public com.liferay.portlet.asset.model.AssetTagProperty deleteAssetTagProperty(
079                    long tagPropertyId)
080                    throws com.liferay.portal.kernel.exception.PortalException,
081                            com.liferay.portal.kernel.exception.SystemException;
082    
083            /**
084            * Deletes the asset tag property from the database. Also notifies the appropriate model listeners.
085            *
086            * @param assetTagProperty the asset tag property
087            * @return the asset tag property that was removed
088            * @throws SystemException if a system exception occurred
089            */
090            public com.liferay.portlet.asset.model.AssetTagProperty deleteAssetTagProperty(
091                    com.liferay.portlet.asset.model.AssetTagProperty assetTagProperty)
092                    throws com.liferay.portal.kernel.exception.SystemException;
093    
094            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
095    
096            /**
097            * Performs a dynamic query on the database and returns the matching rows.
098            *
099            * @param dynamicQuery the dynamic query
100            * @return the matching rows
101            * @throws SystemException if a system exception occurred
102            */
103            @SuppressWarnings("rawtypes")
104            public java.util.List dynamicQuery(
105                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
106                    throws com.liferay.portal.kernel.exception.SystemException;
107    
108            /**
109            * Performs a dynamic query on the database and returns a range of the matching rows.
110            *
111            * <p>
112            * 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.AssetTagPropertyModelImpl}. 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.
113            * </p>
114            *
115            * @param dynamicQuery the dynamic query
116            * @param start the lower bound of the range of model instances
117            * @param end the upper bound of the range of model instances (not inclusive)
118            * @return the range of matching rows
119            * @throws SystemException if a system exception occurred
120            */
121            @SuppressWarnings("rawtypes")
122            public java.util.List dynamicQuery(
123                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
124                    int end) throws com.liferay.portal.kernel.exception.SystemException;
125    
126            /**
127            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
128            *
129            * <p>
130            * 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.AssetTagPropertyModelImpl}. 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.
131            * </p>
132            *
133            * @param dynamicQuery the dynamic query
134            * @param start the lower bound of the range of model instances
135            * @param end the upper bound of the range of model instances (not inclusive)
136            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
137            * @return the ordered range of matching rows
138            * @throws SystemException if a system exception occurred
139            */
140            @SuppressWarnings("rawtypes")
141            public java.util.List dynamicQuery(
142                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
143                    int end,
144                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
145                    throws com.liferay.portal.kernel.exception.SystemException;
146    
147            /**
148            * Returns the number of rows that match the dynamic query.
149            *
150            * @param dynamicQuery the dynamic query
151            * @return the number of rows that match the dynamic query
152            * @throws SystemException if a system exception occurred
153            */
154            public long dynamicQueryCount(
155                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
156                    throws com.liferay.portal.kernel.exception.SystemException;
157    
158            /**
159            * Returns the number of rows that match the dynamic query.
160            *
161            * @param dynamicQuery the dynamic query
162            * @param projection the projection to apply to the query
163            * @return the number of rows that match the dynamic query
164            * @throws SystemException if a system exception occurred
165            */
166            public long dynamicQueryCount(
167                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
168                    com.liferay.portal.kernel.dao.orm.Projection projection)
169                    throws com.liferay.portal.kernel.exception.SystemException;
170    
171            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
172            public com.liferay.portlet.asset.model.AssetTagProperty fetchAssetTagProperty(
173                    long tagPropertyId)
174                    throws com.liferay.portal.kernel.exception.SystemException;
175    
176            /**
177            * Returns the asset tag property with the primary key.
178            *
179            * @param tagPropertyId the primary key of the asset tag property
180            * @return the asset tag property
181            * @throws PortalException if a asset tag property with the primary key could not be found
182            * @throws SystemException if a system exception occurred
183            */
184            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
185            public com.liferay.portlet.asset.model.AssetTagProperty getAssetTagProperty(
186                    long tagPropertyId)
187                    throws com.liferay.portal.kernel.exception.PortalException,
188                            com.liferay.portal.kernel.exception.SystemException;
189    
190            @Override
191            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
192            public com.liferay.portal.model.PersistedModel getPersistedModel(
193                    java.io.Serializable primaryKeyObj)
194                    throws com.liferay.portal.kernel.exception.PortalException,
195                            com.liferay.portal.kernel.exception.SystemException;
196    
197            /**
198            * Returns a range of all the asset tag properties.
199            *
200            * <p>
201            * 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.AssetTagPropertyModelImpl}. 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.
202            * </p>
203            *
204            * @param start the lower bound of the range of asset tag properties
205            * @param end the upper bound of the range of asset tag properties (not inclusive)
206            * @return the range of asset tag properties
207            * @throws SystemException if a system exception occurred
208            */
209            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
210            public java.util.List<com.liferay.portlet.asset.model.AssetTagProperty> getAssetTagProperties(
211                    int start, int end)
212                    throws com.liferay.portal.kernel.exception.SystemException;
213    
214            /**
215            * Returns the number of asset tag properties.
216            *
217            * @return the number of asset tag properties
218            * @throws SystemException if a system exception occurred
219            */
220            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
221            public int getAssetTagPropertiesCount()
222                    throws com.liferay.portal.kernel.exception.SystemException;
223    
224            /**
225            * Updates the asset tag property in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
226            *
227            * @param assetTagProperty the asset tag property
228            * @return the asset tag property that was updated
229            * @throws SystemException if a system exception occurred
230            */
231            public com.liferay.portlet.asset.model.AssetTagProperty updateAssetTagProperty(
232                    com.liferay.portlet.asset.model.AssetTagProperty assetTagProperty)
233                    throws com.liferay.portal.kernel.exception.SystemException;
234    
235            /**
236            * Returns the Spring bean ID for this bean.
237            *
238            * @return the Spring bean ID for this bean
239            */
240            public java.lang.String getBeanIdentifier();
241    
242            /**
243            * Sets the Spring bean ID for this bean.
244            *
245            * @param beanIdentifier the Spring bean ID for this bean
246            */
247            public void setBeanIdentifier(java.lang.String beanIdentifier);
248    
249            /**
250            * Adds an asset tag property.
251            *
252            * @param userId the primary key of the user
253            * @param tagId the primary key of the tag
254            * @param key the key to be associated to the value
255            * @param value the value to which the key will refer
256            * @return the created asset tag property
257            * @throws PortalException if a user with the primary key could not be
258            found, or if the key or value were invalid
259            * @throws SystemException if a system exception occurred
260            */
261            public com.liferay.portlet.asset.model.AssetTagProperty addTagProperty(
262                    long userId, long tagId, java.lang.String key, java.lang.String value)
263                    throws com.liferay.portal.kernel.exception.PortalException,
264                            com.liferay.portal.kernel.exception.SystemException;
265    
266            /**
267            * Deletes the asset tag property with the specified tag ID.
268            *
269            * @param tagId the primary key of the tag
270            * @throws SystemException if a system exception occurred
271            */
272            public void deleteTagProperties(long tagId)
273                    throws com.liferay.portal.kernel.exception.SystemException;
274    
275            /**
276            * Deletes the asset tag property instance.
277            *
278            * @param tagProperty the asset tag property instance
279            * @throws SystemException if a system exception occurred
280            */
281            public void deleteTagProperty(
282                    com.liferay.portlet.asset.model.AssetTagProperty tagProperty)
283                    throws com.liferay.portal.kernel.exception.SystemException;
284    
285            /**
286            * Deletes the asset tag property with the specified ID.
287            *
288            * @param tagPropertyId the primary key of the asset tag property instance
289            * @throws PortalException if an asset tag property with the primary key
290            could not be found
291            * @throws SystemException if a system exception occurred
292            */
293            public void deleteTagProperty(long tagPropertyId)
294                    throws com.liferay.portal.kernel.exception.PortalException,
295                            com.liferay.portal.kernel.exception.SystemException;
296    
297            /**
298            * Returns all the asset tag property instances.
299            *
300            * @return the asset tag property instances
301            * @throws SystemException if a system exception occurred
302            */
303            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
304            public java.util.List<com.liferay.portlet.asset.model.AssetTagProperty> getTagProperties()
305                    throws com.liferay.portal.kernel.exception.SystemException;
306    
307            /**
308            * Returns all the asset tag property instances with the specified tag ID.
309            *
310            * @param tagId the primary key of the tag
311            * @return the matching asset tag properties
312            * @throws SystemException if a system exception occurred
313            */
314            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
315            public java.util.List<com.liferay.portlet.asset.model.AssetTagProperty> getTagProperties(
316                    long tagId) throws com.liferay.portal.kernel.exception.SystemException;
317    
318            /**
319            * Returns the asset tag property with the specified ID.
320            *
321            * @param tagPropertyId the primary key of the asset tag property
322            * @return the matching asset tag property
323            * @throws PortalException if an asset tag property with the primary key
324            could not be found
325            * @throws SystemException if a system exception occurred
326            */
327            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
328            public com.liferay.portlet.asset.model.AssetTagProperty getTagProperty(
329                    long tagPropertyId)
330                    throws com.liferay.portal.kernel.exception.PortalException,
331                            com.liferay.portal.kernel.exception.SystemException;
332    
333            /**
334            * Returns the asset tag property with the specified tag ID and key.
335            *
336            * @param tagId the primary key of the tag
337            * @param key the key that refers to some value
338            * @return the matching asset tag property
339            * @throws PortalException if an asset tag property with the tag ID and key
340            could not be found
341            * @throws SystemException if a system exception occurred
342            */
343            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
344            public com.liferay.portlet.asset.model.AssetTagProperty getTagProperty(
345                    long tagId, java.lang.String key)
346                    throws com.liferay.portal.kernel.exception.PortalException,
347                            com.liferay.portal.kernel.exception.SystemException;
348    
349            /**
350            * Returns asset tag property keys with the specified group
351            *
352            * @param groupId the primary key of the group
353            * @return the matching asset tag property keys
354            * @throws SystemException if a system exception occurred
355            */
356            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
357            public java.lang.String[] getTagPropertyKeys(long groupId)
358                    throws com.liferay.portal.kernel.exception.SystemException;
359    
360            /**
361            * Returns asset tag properties with the specified group and key.
362            *
363            * @param groupId the primary key of the group
364            * @param key the key that refers to some value
365            * @return the matching asset tag properties
366            * @throws SystemException if a system exception occurred
367            */
368            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
369            public java.util.List<com.liferay.portlet.asset.model.AssetTagProperty> getTagPropertyValues(
370                    long groupId, java.lang.String key)
371                    throws com.liferay.portal.kernel.exception.SystemException;
372    
373            /**
374            * Updates the asset tag property.
375            *
376            * @param tagPropertyId the primary key of the asset tag property
377            * @param key the new key to be associated to the value
378            * @param value the new value to which the key will refer
379            * @return the updated asset tag property
380            * @throws PortalException if an asset tag property with the primary key
381            could not be found, or if the key or value were invalid
382            * @throws SystemException if a system exception occurred
383            */
384            public com.liferay.portlet.asset.model.AssetTagProperty updateTagProperty(
385                    long tagPropertyId, java.lang.String key, java.lang.String value)
386                    throws com.liferay.portal.kernel.exception.PortalException,
387                            com.liferay.portal.kernel.exception.SystemException;
388    }