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) 064 throws com.liferay.portal.kernel.exception.PortalException; 065 066 /** 067 * Creates a new asset category property with the primary key. Does not add the asset category property to the database. 068 * 069 * @param categoryPropertyId the primary key for the new asset category property 070 * @return the new asset category property 071 */ 072 public com.liferay.portlet.asset.model.AssetCategoryProperty createAssetCategoryProperty( 073 long categoryPropertyId); 074 075 /** 076 * Deletes the asset category property from the database. Also notifies the appropriate model listeners. 077 * 078 * @param assetCategoryProperty the asset category property 079 * @return the asset category property that was removed 080 */ 081 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 082 public com.liferay.portlet.asset.model.AssetCategoryProperty deleteAssetCategoryProperty( 083 com.liferay.portlet.asset.model.AssetCategoryProperty assetCategoryProperty); 084 085 /** 086 * Deletes the asset category property with the primary key from the database. Also notifies the appropriate model listeners. 087 * 088 * @param categoryPropertyId the primary key of the asset category property 089 * @return the asset category property that was removed 090 * @throws PortalException if a asset category property with the primary key could not be found 091 */ 092 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 093 public com.liferay.portlet.asset.model.AssetCategoryProperty deleteAssetCategoryProperty( 094 long categoryPropertyId) 095 throws com.liferay.portal.kernel.exception.PortalException; 096 097 public void deleteCategoryProperties(long entryId); 098 099 public void deleteCategoryProperty( 100 com.liferay.portlet.asset.model.AssetCategoryProperty categoryProperty); 101 102 public void deleteCategoryProperty(long categoryPropertyId) 103 throws com.liferay.portal.kernel.exception.PortalException; 104 105 /** 106 * @throws PortalException 107 */ 108 @Override 109 public com.liferay.portal.model.PersistedModel deletePersistedModel( 110 com.liferay.portal.model.PersistedModel persistedModel) 111 throws com.liferay.portal.kernel.exception.PortalException; 112 113 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 114 115 /** 116 * Performs a dynamic query on the database and returns the matching rows. 117 * 118 * @param dynamicQuery the dynamic query 119 * @return the matching rows 120 */ 121 public <T> java.util.List<T> dynamicQuery( 122 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 123 124 /** 125 * Performs a dynamic query on the database and returns a 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. 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. 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 * @return the range of matching rows 135 */ 136 public <T> java.util.List<T> dynamicQuery( 137 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 138 int end); 139 140 /** 141 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 142 * 143 * <p> 144 * 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. 145 * </p> 146 * 147 * @param dynamicQuery the dynamic query 148 * @param start the lower bound of the range of model instances 149 * @param end the upper bound of the range of model instances (not inclusive) 150 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 151 * @return the ordered range of matching rows 152 */ 153 public <T> java.util.List<T> dynamicQuery( 154 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 155 int end, 156 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 157 158 /** 159 * Returns the number of rows matching the dynamic query. 160 * 161 * @param dynamicQuery the dynamic query 162 * @return the number of rows matching the dynamic query 163 */ 164 public long dynamicQueryCount( 165 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 166 167 /** 168 * Returns the number of rows matching the dynamic query. 169 * 170 * @param dynamicQuery the dynamic query 171 * @param projection the projection to apply to the query 172 * @return the number of rows matching the dynamic query 173 */ 174 public long dynamicQueryCount( 175 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 176 com.liferay.portal.kernel.dao.orm.Projection projection); 177 178 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 179 public com.liferay.portlet.asset.model.AssetCategoryProperty fetchAssetCategoryProperty( 180 long categoryPropertyId); 181 182 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 183 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 184 185 /** 186 * Returns a range of all the asset category properties. 187 * 188 * <p> 189 * 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. 190 * </p> 191 * 192 * @param start the lower bound of the range of asset category properties 193 * @param end the upper bound of the range of asset category properties (not inclusive) 194 * @return the range of asset category properties 195 */ 196 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 197 public java.util.List<com.liferay.portlet.asset.model.AssetCategoryProperty> getAssetCategoryProperties( 198 int start, int end); 199 200 /** 201 * Returns the number of asset category properties. 202 * 203 * @return the number of asset category properties 204 */ 205 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 206 public int getAssetCategoryPropertiesCount(); 207 208 /** 209 * Returns the asset category property with the primary key. 210 * 211 * @param categoryPropertyId the primary key of the asset category property 212 * @return the asset category property 213 * @throws PortalException if a asset category property with the primary key could not be found 214 */ 215 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 216 public com.liferay.portlet.asset.model.AssetCategoryProperty getAssetCategoryProperty( 217 long categoryPropertyId) 218 throws com.liferay.portal.kernel.exception.PortalException; 219 220 /** 221 * Returns the Spring bean ID for this bean. 222 * 223 * @return the Spring bean ID for this bean 224 */ 225 public java.lang.String getBeanIdentifier(); 226 227 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 228 public java.util.List<com.liferay.portlet.asset.model.AssetCategoryProperty> getCategoryProperties(); 229 230 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 231 public java.util.List<com.liferay.portlet.asset.model.AssetCategoryProperty> getCategoryProperties( 232 long entryId); 233 234 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 235 public com.liferay.portlet.asset.model.AssetCategoryProperty getCategoryProperty( 236 long categoryId, java.lang.String key) 237 throws com.liferay.portal.kernel.exception.PortalException; 238 239 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 240 public com.liferay.portlet.asset.model.AssetCategoryProperty getCategoryProperty( 241 long categoryPropertyId) 242 throws com.liferay.portal.kernel.exception.PortalException; 243 244 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 245 public java.util.List<com.liferay.portlet.asset.model.AssetCategoryProperty> getCategoryPropertyValues( 246 long groupId, java.lang.String key); 247 248 @Override 249 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 250 public com.liferay.portal.model.PersistedModel getPersistedModel( 251 java.io.Serializable primaryKeyObj) 252 throws com.liferay.portal.kernel.exception.PortalException; 253 254 /** 255 * Sets the Spring bean ID for this bean. 256 * 257 * @param beanIdentifier the Spring bean ID for this bean 258 */ 259 public void setBeanIdentifier(java.lang.String beanIdentifier); 260 261 /** 262 * Updates the asset category property in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 263 * 264 * @param assetCategoryProperty the asset category property 265 * @return the asset category property that was updated 266 */ 267 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 268 public com.liferay.portlet.asset.model.AssetCategoryProperty updateAssetCategoryProperty( 269 com.liferay.portlet.asset.model.AssetCategoryProperty assetCategoryProperty); 270 271 public com.liferay.portlet.asset.model.AssetCategoryProperty updateCategoryProperty( 272 long categoryPropertyId, java.lang.String key, java.lang.String value) 273 throws com.liferay.portal.kernel.exception.PortalException; 274 275 public com.liferay.portlet.asset.model.AssetCategoryProperty updateCategoryProperty( 276 long userId, long categoryPropertyId, java.lang.String key, 277 java.lang.String value) 278 throws com.liferay.portal.kernel.exception.PortalException; 279 }