001 /** 002 * Copyright (c) 2000-2010 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.annotation.Isolation; 018 import com.liferay.portal.kernel.annotation.Propagation; 019 import com.liferay.portal.kernel.annotation.Transactional; 020 import com.liferay.portal.kernel.exception.PortalException; 021 import com.liferay.portal.kernel.exception.SystemException; 022 023 /** 024 * The interface for the asset vocabulary local service. 025 * 026 * <p> 027 * Never modify or reference this interface directly. Always use {@link AssetVocabularyLocalServiceUtil} to access the asset vocabulary local service. Add custom service methods to {@link com.liferay.portlet.asset.service.impl.AssetVocabularyLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 028 * </p> 029 * 030 * <p> 031 * 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. 032 * </p> 033 * 034 * @author Brian Wing Shun Chan 035 * @see AssetVocabularyLocalServiceUtil 036 * @see com.liferay.portlet.asset.service.base.AssetVocabularyLocalServiceBaseImpl 037 * @see com.liferay.portlet.asset.service.impl.AssetVocabularyLocalServiceImpl 038 * @generated 039 */ 040 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 041 PortalException.class, SystemException.class}) 042 public interface AssetVocabularyLocalService { 043 /** 044 * Adds the asset vocabulary to the database. Also notifies the appropriate model listeners. 045 * 046 * @param assetVocabulary the asset vocabulary to add 047 * @return the asset vocabulary that was added 048 * @throws SystemException if a system exception occurred 049 */ 050 public com.liferay.portlet.asset.model.AssetVocabulary addAssetVocabulary( 051 com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary) 052 throws com.liferay.portal.kernel.exception.SystemException; 053 054 /** 055 * Creates a new asset vocabulary with the primary key. Does not add the asset vocabulary to the database. 056 * 057 * @param vocabularyId the primary key for the new asset vocabulary 058 * @return the new asset vocabulary 059 */ 060 public com.liferay.portlet.asset.model.AssetVocabulary createAssetVocabulary( 061 long vocabularyId); 062 063 /** 064 * Deletes the asset vocabulary with the primary key from the database. Also notifies the appropriate model listeners. 065 * 066 * @param vocabularyId the primary key of the asset vocabulary to delete 067 * @throws PortalException if a asset vocabulary with the primary key could not be found 068 * @throws SystemException if a system exception occurred 069 */ 070 public void deleteAssetVocabulary(long vocabularyId) 071 throws com.liferay.portal.kernel.exception.PortalException, 072 com.liferay.portal.kernel.exception.SystemException; 073 074 /** 075 * Deletes the asset vocabulary from the database. Also notifies the appropriate model listeners. 076 * 077 * @param assetVocabulary the asset vocabulary to delete 078 * @throws SystemException if a system exception occurred 079 */ 080 public void deleteAssetVocabulary( 081 com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary) 082 throws com.liferay.portal.kernel.exception.SystemException; 083 084 /** 085 * Performs a dynamic query on the database and returns the matching rows. 086 * 087 * @param dynamicQuery the dynamic query to search with 088 * @return the matching rows 089 * @throws SystemException if a system exception occurred 090 */ 091 @SuppressWarnings("rawtypes") 092 public java.util.List dynamicQuery( 093 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 094 throws com.liferay.portal.kernel.exception.SystemException; 095 096 /** 097 * Performs a dynamic query on the database and returns a range of the matching rows. 098 * 099 * <p> 100 * 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. 101 * </p> 102 * 103 * @param dynamicQuery the dynamic query to search with 104 * @param start the lower bound of the range of model instances to return 105 * @param end the upper bound of the range of model instances to return (not inclusive) 106 * @return the range of matching rows 107 * @throws SystemException if a system exception occurred 108 */ 109 @SuppressWarnings("rawtypes") 110 public java.util.List dynamicQuery( 111 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 112 int end) throws com.liferay.portal.kernel.exception.SystemException; 113 114 /** 115 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 116 * 117 * <p> 118 * 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. 119 * </p> 120 * 121 * @param dynamicQuery the dynamic query to search with 122 * @param start the lower bound of the range of model instances to return 123 * @param end the upper bound of the range of model instances to return (not inclusive) 124 * @param orderByComparator the comparator to order the results by 125 * @return the ordered range of matching rows 126 * @throws SystemException if a system exception occurred 127 */ 128 @SuppressWarnings("rawtypes") 129 public java.util.List dynamicQuery( 130 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 131 int end, 132 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 133 throws com.liferay.portal.kernel.exception.SystemException; 134 135 /** 136 * Counts the number of rows that match the dynamic query. 137 * 138 * @param dynamicQuery the dynamic query to search with 139 * @return the number of rows that match the dynamic query 140 * @throws SystemException if a system exception occurred 141 */ 142 public long dynamicQueryCount( 143 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 144 throws com.liferay.portal.kernel.exception.SystemException; 145 146 /** 147 * Gets the asset vocabulary with the primary key. 148 * 149 * @param vocabularyId the primary key of the asset vocabulary to get 150 * @return the asset vocabulary 151 * @throws PortalException if a asset vocabulary with the primary key could not be found 152 * @throws SystemException if a system exception occurred 153 */ 154 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 155 public com.liferay.portlet.asset.model.AssetVocabulary getAssetVocabulary( 156 long vocabularyId) 157 throws com.liferay.portal.kernel.exception.PortalException, 158 com.liferay.portal.kernel.exception.SystemException; 159 160 /** 161 * Gets the asset vocabulary with the UUID and group id. 162 * 163 * @param uuid the UUID of asset vocabulary to get 164 * @param groupId the group id of the asset vocabulary to get 165 * @return the asset vocabulary 166 * @throws PortalException if a asset vocabulary with the UUID and group id 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.AssetVocabulary getAssetVocabularyByUuidAndGroupId( 171 java.lang.String uuid, long groupId) 172 throws com.liferay.portal.kernel.exception.PortalException, 173 com.liferay.portal.kernel.exception.SystemException; 174 175 /** 176 * Gets a range of all the asset vocabularies. 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 vocabularies to return 183 * @param end the upper bound of the range of asset vocabularies to return (not inclusive) 184 * @return the range of asset vocabularies 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.AssetVocabulary> getAssetVocabularies( 189 int start, int end) 190 throws com.liferay.portal.kernel.exception.SystemException; 191 192 /** 193 * Gets the number of asset vocabularies. 194 * 195 * @return the number of asset vocabularies 196 * @throws SystemException if a system exception occurred 197 */ 198 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 199 public int getAssetVocabulariesCount() 200 throws com.liferay.portal.kernel.exception.SystemException; 201 202 /** 203 * Updates the asset vocabulary in the database. Also notifies the appropriate model listeners. 204 * 205 * @param assetVocabulary the asset vocabulary to update 206 * @return the asset vocabulary that was updated 207 * @throws SystemException if a system exception occurred 208 */ 209 public com.liferay.portlet.asset.model.AssetVocabulary updateAssetVocabulary( 210 com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary) 211 throws com.liferay.portal.kernel.exception.SystemException; 212 213 /** 214 * Updates the asset vocabulary in the database. Also notifies the appropriate model listeners. 215 * 216 * @param assetVocabulary the asset vocabulary to update 217 * @param merge whether to merge the asset vocabulary 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 vocabulary that was updated 219 * @throws SystemException if a system exception occurred 220 */ 221 public com.liferay.portlet.asset.model.AssetVocabulary updateAssetVocabulary( 222 com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary, 223 boolean merge) 224 throws com.liferay.portal.kernel.exception.SystemException; 225 226 public com.liferay.portlet.asset.model.AssetVocabulary addVocabulary( 227 long userId, 228 java.util.Map<java.util.Locale, java.lang.String> titleMap, 229 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 230 java.lang.String settings, 231 com.liferay.portal.service.ServiceContext serviceContext) 232 throws com.liferay.portal.kernel.exception.PortalException, 233 com.liferay.portal.kernel.exception.SystemException; 234 235 public void addVocabularyResources( 236 com.liferay.portlet.asset.model.AssetVocabulary vocabulary, 237 boolean addCommunityPermissions, boolean addGuestPermissions) 238 throws com.liferay.portal.kernel.exception.PortalException, 239 com.liferay.portal.kernel.exception.SystemException; 240 241 public void addVocabularyResources( 242 com.liferay.portlet.asset.model.AssetVocabulary vocabulary, 243 java.lang.String[] communityPermissions, 244 java.lang.String[] guestPermissions) 245 throws com.liferay.portal.kernel.exception.PortalException, 246 com.liferay.portal.kernel.exception.SystemException; 247 248 public void deleteVocabulary( 249 com.liferay.portlet.asset.model.AssetVocabulary vocabulary) 250 throws com.liferay.portal.kernel.exception.PortalException, 251 com.liferay.portal.kernel.exception.SystemException; 252 253 public void deleteVocabulary(long vocabularyId) 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.AssetVocabulary> getCompanyVocabularies( 259 long companyId) 260 throws com.liferay.portal.kernel.exception.SystemException; 261 262 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 263 public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupsVocabularies( 264 long[] groupIds) 265 throws com.liferay.portal.kernel.exception.PortalException, 266 com.liferay.portal.kernel.exception.SystemException; 267 268 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 269 public java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupVocabularies( 270 long groupId) 271 throws com.liferay.portal.kernel.exception.PortalException, 272 com.liferay.portal.kernel.exception.SystemException; 273 274 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 275 public com.liferay.portlet.asset.model.AssetVocabulary getGroupVocabulary( 276 long groupId, java.lang.String name) 277 throws com.liferay.portal.kernel.exception.PortalException, 278 com.liferay.portal.kernel.exception.SystemException; 279 280 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 281 public com.liferay.portlet.asset.model.AssetVocabulary getVocabulary( 282 long vocabularyId) 283 throws com.liferay.portal.kernel.exception.PortalException, 284 com.liferay.portal.kernel.exception.SystemException; 285 286 public com.liferay.portlet.asset.model.AssetVocabulary updateVocabulary( 287 long vocabularyId, 288 java.util.Map<java.util.Locale, java.lang.String> titleMap, 289 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 290 java.lang.String settings, 291 com.liferay.portal.service.ServiceContext serviceContext) 292 throws com.liferay.portal.kernel.exception.PortalException, 293 com.liferay.portal.kernel.exception.SystemException; 294 }