001 /** 002 * Copyright (c) 2000-2012 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.PersistedModelLocalService; 023 024 /** 025 * The interface for the asset category property local service. 026 * 027 * <p> 028 * 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. 029 * </p> 030 * 031 * @author Brian Wing Shun Chan 032 * @see AssetCategoryPropertyLocalServiceUtil 033 * @see com.liferay.portlet.asset.service.base.AssetCategoryPropertyLocalServiceBaseImpl 034 * @see com.liferay.portlet.asset.service.impl.AssetCategoryPropertyLocalServiceImpl 035 * @generated 036 */ 037 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 038 PortalException.class, SystemException.class}) 039 public interface AssetCategoryPropertyLocalService 040 extends PersistedModelLocalService { 041 /* 042 * NOTE FOR DEVELOPERS: 043 * 044 * 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. 045 */ 046 047 /** 048 * Adds the asset category property to the database. Also notifies the appropriate model listeners. 049 * 050 * @param assetCategoryProperty the asset category property 051 * @return the asset category property that was added 052 * @throws SystemException if a system exception occurred 053 */ 054 public com.liferay.portlet.asset.model.AssetCategoryProperty addAssetCategoryProperty( 055 com.liferay.portlet.asset.model.AssetCategoryProperty assetCategoryProperty) 056 throws com.liferay.portal.kernel.exception.SystemException; 057 058 /** 059 * Creates a new asset category property with the primary key. Does not add the asset category property to the database. 060 * 061 * @param categoryPropertyId the primary key for the new asset category property 062 * @return the new asset category property 063 */ 064 public com.liferay.portlet.asset.model.AssetCategoryProperty createAssetCategoryProperty( 065 long categoryPropertyId); 066 067 /** 068 * Deletes the asset category property with the primary key from the database. Also notifies the appropriate model listeners. 069 * 070 * @param categoryPropertyId the primary key of the asset category property 071 * @throws PortalException if a asset category property with the primary key could not be found 072 * @throws SystemException if a system exception occurred 073 */ 074 public void deleteAssetCategoryProperty(long categoryPropertyId) 075 throws com.liferay.portal.kernel.exception.PortalException, 076 com.liferay.portal.kernel.exception.SystemException; 077 078 /** 079 * Deletes the asset category property from the database. Also notifies the appropriate model listeners. 080 * 081 * @param assetCategoryProperty the asset category property 082 * @throws SystemException if a system exception occurred 083 */ 084 public void deleteAssetCategoryProperty( 085 com.liferay.portlet.asset.model.AssetCategoryProperty assetCategoryProperty) 086 throws com.liferay.portal.kernel.exception.SystemException; 087 088 /** 089 * Performs a dynamic query on the database and returns the matching rows. 090 * 091 * @param dynamicQuery the dynamic query 092 * @return the matching rows 093 * @throws SystemException if a system exception occurred 094 */ 095 @SuppressWarnings("rawtypes") 096 public java.util.List dynamicQuery( 097 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 098 throws com.liferay.portal.kernel.exception.SystemException; 099 100 /** 101 * Performs a dynamic query on the database and returns a range of the matching rows. 102 * 103 * <p> 104 * 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. 105 * </p> 106 * 107 * @param dynamicQuery the dynamic query 108 * @param start the lower bound of the range of model instances 109 * @param end the upper bound of the range of model instances (not inclusive) 110 * @return the range of matching rows 111 * @throws SystemException if a system exception occurred 112 */ 113 @SuppressWarnings("rawtypes") 114 public java.util.List dynamicQuery( 115 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 116 int end) throws com.liferay.portal.kernel.exception.SystemException; 117 118 /** 119 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 120 * 121 * <p> 122 * 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. 123 * </p> 124 * 125 * @param dynamicQuery the dynamic query 126 * @param start the lower bound of the range of model instances 127 * @param end the upper bound of the range of model instances (not inclusive) 128 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 129 * @return the ordered range of matching rows 130 * @throws SystemException if a system exception occurred 131 */ 132 @SuppressWarnings("rawtypes") 133 public java.util.List dynamicQuery( 134 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 135 int end, 136 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 137 throws com.liferay.portal.kernel.exception.SystemException; 138 139 /** 140 * Returns the number of rows that match the dynamic query. 141 * 142 * @param dynamicQuery the dynamic query 143 * @return the number of rows that match the dynamic query 144 * @throws SystemException if a system exception occurred 145 */ 146 public long dynamicQueryCount( 147 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 148 throws com.liferay.portal.kernel.exception.SystemException; 149 150 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 151 public com.liferay.portlet.asset.model.AssetCategoryProperty fetchAssetCategoryProperty( 152 long categoryPropertyId) 153 throws com.liferay.portal.kernel.exception.SystemException; 154 155 /** 156 * Returns the asset category property with the primary key. 157 * 158 * @param categoryPropertyId the primary key of the asset category property 159 * @return the asset category property 160 * @throws PortalException if a asset category property with the primary key could not be found 161 * @throws SystemException if a system exception occurred 162 */ 163 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 164 public com.liferay.portlet.asset.model.AssetCategoryProperty getAssetCategoryProperty( 165 long categoryPropertyId) 166 throws com.liferay.portal.kernel.exception.PortalException, 167 com.liferay.portal.kernel.exception.SystemException; 168 169 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 170 public com.liferay.portal.model.PersistedModel getPersistedModel( 171 java.io.Serializable primaryKeyObj) 172 throws com.liferay.portal.kernel.exception.PortalException, 173 com.liferay.portal.kernel.exception.SystemException; 174 175 /** 176 * Returns a range of all the asset category properties. 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 category properties 183 * @param end the upper bound of the range of asset category properties (not inclusive) 184 * @return the range of asset category properties 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.AssetCategoryProperty> getAssetCategoryProperties( 189 int start, int end) 190 throws com.liferay.portal.kernel.exception.SystemException; 191 192 /** 193 * Returns the number of asset category properties. 194 * 195 * @return the number of asset category properties 196 * @throws SystemException if a system exception occurred 197 */ 198 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 199 public int getAssetCategoryPropertiesCount() 200 throws com.liferay.portal.kernel.exception.SystemException; 201 202 /** 203 * Updates the asset category property in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 204 * 205 * @param assetCategoryProperty the asset category property 206 * @return the asset category property that was updated 207 * @throws SystemException if a system exception occurred 208 */ 209 public com.liferay.portlet.asset.model.AssetCategoryProperty updateAssetCategoryProperty( 210 com.liferay.portlet.asset.model.AssetCategoryProperty assetCategoryProperty) 211 throws com.liferay.portal.kernel.exception.SystemException; 212 213 /** 214 * Updates the asset category property in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 215 * 216 * @param assetCategoryProperty the asset category property 217 * @param merge whether to merge the asset category 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. 218 * @return the asset category property that was updated 219 * @throws SystemException if a system exception occurred 220 */ 221 public com.liferay.portlet.asset.model.AssetCategoryProperty updateAssetCategoryProperty( 222 com.liferay.portlet.asset.model.AssetCategoryProperty assetCategoryProperty, 223 boolean merge) 224 throws com.liferay.portal.kernel.exception.SystemException; 225 226 /** 227 * Returns the Spring bean ID for this bean. 228 * 229 * @return the Spring bean ID for this bean 230 */ 231 public java.lang.String getBeanIdentifier(); 232 233 /** 234 * Sets the Spring bean ID for this bean. 235 * 236 * @param beanIdentifier the Spring bean ID for this bean 237 */ 238 public void setBeanIdentifier(java.lang.String beanIdentifier); 239 240 public com.liferay.portlet.asset.model.AssetCategoryProperty addCategoryProperty( 241 long userId, long categoryId, java.lang.String key, 242 java.lang.String value) 243 throws com.liferay.portal.kernel.exception.PortalException, 244 com.liferay.portal.kernel.exception.SystemException; 245 246 public void deleteCategoryProperties(long entryId) 247 throws com.liferay.portal.kernel.exception.SystemException; 248 249 public void deleteCategoryProperty( 250 com.liferay.portlet.asset.model.AssetCategoryProperty categoryProperty) 251 throws com.liferay.portal.kernel.exception.SystemException; 252 253 public void deleteCategoryProperty(long categoryPropertyId) 254 throws com.liferay.portal.kernel.exception.PortalException, 255 com.liferay.portal.kernel.exception.SystemException; 256 257 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 258 public java.util.List<com.liferay.portlet.asset.model.AssetCategoryProperty> getCategoryProperties() 259 throws com.liferay.portal.kernel.exception.SystemException; 260 261 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 262 public java.util.List<com.liferay.portlet.asset.model.AssetCategoryProperty> getCategoryProperties( 263 long entryId) 264 throws com.liferay.portal.kernel.exception.SystemException; 265 266 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 267 public com.liferay.portlet.asset.model.AssetCategoryProperty getCategoryProperty( 268 long categoryPropertyId) 269 throws com.liferay.portal.kernel.exception.PortalException, 270 com.liferay.portal.kernel.exception.SystemException; 271 272 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 273 public com.liferay.portlet.asset.model.AssetCategoryProperty getCategoryProperty( 274 long categoryId, java.lang.String key) 275 throws com.liferay.portal.kernel.exception.PortalException, 276 com.liferay.portal.kernel.exception.SystemException; 277 278 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 279 public java.util.List<com.liferay.portlet.asset.model.AssetCategoryProperty> getCategoryPropertyValues( 280 long groupId, java.lang.String key) 281 throws com.liferay.portal.kernel.exception.SystemException; 282 283 public com.liferay.portlet.asset.model.AssetCategoryProperty updateCategoryProperty( 284 long categoryPropertyId, java.lang.String key, java.lang.String value) 285 throws com.liferay.portal.kernel.exception.PortalException, 286 com.liferay.portal.kernel.exception.SystemException; 287 }