001    /**
002     * Copyright (c) 2000-present 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.search.IndexableType;
022    import com.liferay.portal.kernel.transaction.Isolation;
023    import com.liferay.portal.kernel.transaction.Propagation;
024    import com.liferay.portal.kernel.transaction.Transactional;
025    import com.liferay.portal.service.BaseLocalService;
026    import com.liferay.portal.service.PersistedModelLocalService;
027    
028    /**
029     * Provides the local service interface for AssetCategoryProperty. Methods of this
030     * service will not have security checks based on the propagated JAAS
031     * credentials because this service can only be accessed from within the same
032     * VM.
033     *
034     * @author Brian Wing Shun Chan
035     * @see AssetCategoryPropertyLocalServiceUtil
036     * @see com.liferay.portlet.asset.service.base.AssetCategoryPropertyLocalServiceBaseImpl
037     * @see com.liferay.portlet.asset.service.impl.AssetCategoryPropertyLocalServiceImpl
038     * @generated
039     */
040    @ProviderType
041    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
042            PortalException.class, SystemException.class})
043    public interface AssetCategoryPropertyLocalService extends BaseLocalService,
044            PersistedModelLocalService {
045            /*
046             * NOTE FOR DEVELOPERS:
047             *
048             * Never modify or reference this interface directly. Always use {@link AssetCategoryPropertyLocalServiceUtil} to access the asset category property local service. Add custom service methods to {@link com.liferay.portlet.asset.service.impl.AssetCategoryPropertyLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
049             */
050    
051            /**
052            * Adds the asset category property to the database. Also notifies the appropriate model listeners.
053            *
054            * @param assetCategoryProperty the asset category property
055            * @return the asset category property that was added
056            */
057            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
058            public com.liferay.portlet.asset.model.AssetCategoryProperty addAssetCategoryProperty(
059                    com.liferay.portlet.asset.model.AssetCategoryProperty assetCategoryProperty);
060    
061            public com.liferay.portlet.asset.model.AssetCategoryProperty addCategoryProperty(
062                    long userId, long categoryId, java.lang.String key,
063                    java.lang.String value) throws PortalException;
064    
065            /**
066            * Creates a new asset category property with the primary key. Does not add the asset category property to the database.
067            *
068            * @param categoryPropertyId the primary key for the new asset category property
069            * @return the new asset category property
070            */
071            public com.liferay.portlet.asset.model.AssetCategoryProperty createAssetCategoryProperty(
072                    long categoryPropertyId);
073    
074            /**
075            * Deletes the asset category property from the database. Also notifies the appropriate model listeners.
076            *
077            * @param assetCategoryProperty the asset category property
078            * @return the asset category property that was removed
079            */
080            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
081            public com.liferay.portlet.asset.model.AssetCategoryProperty deleteAssetCategoryProperty(
082                    com.liferay.portlet.asset.model.AssetCategoryProperty assetCategoryProperty);
083    
084            /**
085            * Deletes the asset category property with the primary key from the database. Also notifies the appropriate model listeners.
086            *
087            * @param categoryPropertyId the primary key of the asset category property
088            * @return the asset category property that was removed
089            * @throws PortalException if a asset category property with the primary key could not be found
090            */
091            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
092            public com.liferay.portlet.asset.model.AssetCategoryProperty deleteAssetCategoryProperty(
093                    long categoryPropertyId) throws PortalException;
094    
095            public void deleteCategoryProperties(long entryId);
096    
097            public void deleteCategoryProperty(
098                    com.liferay.portlet.asset.model.AssetCategoryProperty categoryProperty);
099    
100            public void deleteCategoryProperty(long categoryPropertyId)
101                    throws PortalException;
102    
103            /**
104            * @throws PortalException
105            */
106            @Override
107            public com.liferay.portal.model.PersistedModel deletePersistedModel(
108                    com.liferay.portal.model.PersistedModel persistedModel)
109                    throws PortalException;
110    
111            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
112    
113            /**
114            * Performs a dynamic query on the database and returns the matching rows.
115            *
116            * @param dynamicQuery the dynamic query
117            * @return the matching rows
118            */
119            public <T> java.util.List<T> dynamicQuery(
120                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
121    
122            /**
123            * Performs a dynamic query on the database and returns a range of the matching rows.
124            *
125            * <p>
126            * 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.AssetCategoryPropertyModelImpl}. 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.
127            * </p>
128            *
129            * @param dynamicQuery the dynamic query
130            * @param start the lower bound of the range of model instances
131            * @param end the upper bound of the range of model instances (not inclusive)
132            * @return the range of matching rows
133            */
134            public <T> java.util.List<T> dynamicQuery(
135                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
136                    int end);
137    
138            /**
139            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
140            *
141            * <p>
142            * 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.AssetCategoryPropertyModelImpl}. 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.
143            * </p>
144            *
145            * @param dynamicQuery the dynamic query
146            * @param start the lower bound of the range of model instances
147            * @param end the upper bound of the range of model instances (not inclusive)
148            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
149            * @return the ordered range of matching rows
150            */
151            public <T> java.util.List<T> dynamicQuery(
152                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
153                    int end,
154                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
155    
156            /**
157            * Returns the number of rows matching the dynamic query.
158            *
159            * @param dynamicQuery the dynamic query
160            * @return the number of rows matching the dynamic query
161            */
162            public long dynamicQueryCount(
163                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
164    
165            /**
166            * Returns the number of rows matching the dynamic query.
167            *
168            * @param dynamicQuery the dynamic query
169            * @param projection the projection to apply to the query
170            * @return the number of rows matching the dynamic query
171            */
172            public long dynamicQueryCount(
173                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
174                    com.liferay.portal.kernel.dao.orm.Projection projection);
175    
176            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
177            public com.liferay.portlet.asset.model.AssetCategoryProperty fetchAssetCategoryProperty(
178                    long categoryPropertyId);
179    
180            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
181            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
182    
183            /**
184            * Returns a range of all the asset category properties.
185            *
186            * <p>
187            * 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.AssetCategoryPropertyModelImpl}. 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.
188            * </p>
189            *
190            * @param start the lower bound of the range of asset category properties
191            * @param end the upper bound of the range of asset category properties (not inclusive)
192            * @return the range of asset category properties
193            */
194            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
195            public java.util.List<com.liferay.portlet.asset.model.AssetCategoryProperty> getAssetCategoryProperties(
196                    int start, int end);
197    
198            /**
199            * Returns the number of asset category properties.
200            *
201            * @return the number of asset category properties
202            */
203            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
204            public int getAssetCategoryPropertiesCount();
205    
206            /**
207            * Returns the asset category property with the primary key.
208            *
209            * @param categoryPropertyId the primary key of the asset category property
210            * @return the asset category property
211            * @throws PortalException if a asset category property with the primary key could not be found
212            */
213            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
214            public com.liferay.portlet.asset.model.AssetCategoryProperty getAssetCategoryProperty(
215                    long categoryPropertyId) throws PortalException;
216    
217            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
218            public java.util.List<com.liferay.portlet.asset.model.AssetCategoryProperty> getCategoryProperties();
219    
220            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
221            public java.util.List<com.liferay.portlet.asset.model.AssetCategoryProperty> getCategoryProperties(
222                    long entryId);
223    
224            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
225            public com.liferay.portlet.asset.model.AssetCategoryProperty getCategoryProperty(
226                    long categoryId, java.lang.String key) throws PortalException;
227    
228            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
229            public com.liferay.portlet.asset.model.AssetCategoryProperty getCategoryProperty(
230                    long categoryPropertyId) throws PortalException;
231    
232            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
233            public java.util.List<com.liferay.portlet.asset.model.AssetCategoryProperty> getCategoryPropertyValues(
234                    long groupId, java.lang.String key);
235    
236            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
237            public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
238    
239            /**
240            * Returns the OSGi service identifier.
241            *
242            * @return the OSGi service identifier
243            */
244            public java.lang.String getOSGiServiceIdentifier();
245    
246            @Override
247            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
248            public com.liferay.portal.model.PersistedModel getPersistedModel(
249                    java.io.Serializable primaryKeyObj) throws PortalException;
250    
251            /**
252            * Updates the asset category property in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
253            *
254            * @param assetCategoryProperty the asset category property
255            * @return the asset category property that was updated
256            */
257            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
258            public com.liferay.portlet.asset.model.AssetCategoryProperty updateAssetCategoryProperty(
259                    com.liferay.portlet.asset.model.AssetCategoryProperty assetCategoryProperty);
260    
261            public com.liferay.portlet.asset.model.AssetCategoryProperty updateCategoryProperty(
262                    long categoryPropertyId, java.lang.String key, java.lang.String value)
263                    throws PortalException;
264    
265            public com.liferay.portlet.asset.model.AssetCategoryProperty updateCategoryProperty(
266                    long userId, long categoryPropertyId, java.lang.String key,
267                    java.lang.String value) throws PortalException;
268    }