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.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 AssetLink. 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 AssetLinkLocalServiceUtil 036 * @see com.liferay.portlet.asset.service.base.AssetLinkLocalServiceBaseImpl 037 * @see com.liferay.portlet.asset.service.impl.AssetLinkLocalServiceImpl 038 * @generated 039 */ 040 @ProviderType 041 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 042 PortalException.class, SystemException.class}) 043 public interface AssetLinkLocalService extends BaseLocalService, 044 PersistedModelLocalService { 045 /* 046 * NOTE FOR DEVELOPERS: 047 * 048 * Never modify or reference this interface directly. Always use {@link AssetLinkLocalServiceUtil} to access the asset link local service. Add custom service methods to {@link com.liferay.portlet.asset.service.impl.AssetLinkLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 049 */ 050 051 /** 052 * Adds the asset link to the database. Also notifies the appropriate model listeners. 053 * 054 * @param assetLink the asset link 055 * @return the asset link that was added 056 * @throws SystemException if a system exception occurred 057 */ 058 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 059 public com.liferay.portlet.asset.model.AssetLink addAssetLink( 060 com.liferay.portlet.asset.model.AssetLink assetLink) 061 throws com.liferay.portal.kernel.exception.SystemException; 062 063 /** 064 * Creates a new asset link with the primary key. Does not add the asset link to the database. 065 * 066 * @param linkId the primary key for the new asset link 067 * @return the new asset link 068 */ 069 public com.liferay.portlet.asset.model.AssetLink createAssetLink( 070 long linkId); 071 072 /** 073 * Deletes the asset link with the primary key from the database. Also notifies the appropriate model listeners. 074 * 075 * @param linkId the primary key of the asset link 076 * @return the asset link that was removed 077 * @throws PortalException if a asset link with the primary key could not be found 078 * @throws SystemException if a system exception occurred 079 */ 080 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 081 public com.liferay.portlet.asset.model.AssetLink deleteAssetLink( 082 long linkId) 083 throws com.liferay.portal.kernel.exception.PortalException, 084 com.liferay.portal.kernel.exception.SystemException; 085 086 /** 087 * Deletes the asset link from the database. Also notifies the appropriate model listeners. 088 * 089 * @param assetLink the asset link 090 * @return the asset link that was removed 091 * @throws SystemException if a system exception occurred 092 */ 093 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 094 public com.liferay.portlet.asset.model.AssetLink deleteAssetLink( 095 com.liferay.portlet.asset.model.AssetLink assetLink) 096 throws com.liferay.portal.kernel.exception.SystemException; 097 098 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 099 100 /** 101 * Performs a dynamic query on the database and returns the matching rows. 102 * 103 * @param dynamicQuery the dynamic query 104 * @return the matching rows 105 * @throws SystemException if a system exception occurred 106 */ 107 @SuppressWarnings("rawtypes") 108 public java.util.List dynamicQuery( 109 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 110 throws com.liferay.portal.kernel.exception.SystemException; 111 112 /** 113 * Performs a dynamic query on the database and returns a range of the matching rows. 114 * 115 * <p> 116 * 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.AssetLinkModelImpl}. 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. 117 * </p> 118 * 119 * @param dynamicQuery the dynamic query 120 * @param start the lower bound of the range of model instances 121 * @param end the upper bound of the range of model instances (not inclusive) 122 * @return the range of matching rows 123 * @throws SystemException if a system exception occurred 124 */ 125 @SuppressWarnings("rawtypes") 126 public java.util.List dynamicQuery( 127 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 128 int end) throws com.liferay.portal.kernel.exception.SystemException; 129 130 /** 131 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 132 * 133 * <p> 134 * 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.AssetLinkModelImpl}. 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. 135 * </p> 136 * 137 * @param dynamicQuery the dynamic query 138 * @param start the lower bound of the range of model instances 139 * @param end the upper bound of the range of model instances (not inclusive) 140 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 141 * @return the ordered range of matching rows 142 * @throws SystemException if a system exception occurred 143 */ 144 @SuppressWarnings("rawtypes") 145 public java.util.List dynamicQuery( 146 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 147 int end, 148 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 149 throws com.liferay.portal.kernel.exception.SystemException; 150 151 /** 152 * Returns the number of rows that match the dynamic query. 153 * 154 * @param dynamicQuery the dynamic query 155 * @return the number of rows that match the dynamic query 156 * @throws SystemException if a system exception occurred 157 */ 158 public long dynamicQueryCount( 159 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 160 throws com.liferay.portal.kernel.exception.SystemException; 161 162 /** 163 * Returns the number of rows that match the dynamic query. 164 * 165 * @param dynamicQuery the dynamic query 166 * @param projection the projection to apply to the query 167 * @return the number of rows that match the dynamic query 168 * @throws SystemException if a system exception occurred 169 */ 170 public long dynamicQueryCount( 171 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 172 com.liferay.portal.kernel.dao.orm.Projection projection) 173 throws com.liferay.portal.kernel.exception.SystemException; 174 175 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 176 public com.liferay.portlet.asset.model.AssetLink fetchAssetLink(long linkId) 177 throws com.liferay.portal.kernel.exception.SystemException; 178 179 /** 180 * Returns the asset link with the primary key. 181 * 182 * @param linkId the primary key of the asset link 183 * @return the asset link 184 * @throws PortalException if a asset link with the primary key could not be found 185 * @throws SystemException if a system exception occurred 186 */ 187 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 188 public com.liferay.portlet.asset.model.AssetLink getAssetLink(long linkId) 189 throws com.liferay.portal.kernel.exception.PortalException, 190 com.liferay.portal.kernel.exception.SystemException; 191 192 @Override 193 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 194 public com.liferay.portal.model.PersistedModel getPersistedModel( 195 java.io.Serializable primaryKeyObj) 196 throws com.liferay.portal.kernel.exception.PortalException, 197 com.liferay.portal.kernel.exception.SystemException; 198 199 /** 200 * Returns a range of all the asset links. 201 * 202 * <p> 203 * 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.AssetLinkModelImpl}. 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. 204 * </p> 205 * 206 * @param start the lower bound of the range of asset links 207 * @param end the upper bound of the range of asset links (not inclusive) 208 * @return the range of asset links 209 * @throws SystemException if a system exception occurred 210 */ 211 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 212 public java.util.List<com.liferay.portlet.asset.model.AssetLink> getAssetLinks( 213 int start, int end) 214 throws com.liferay.portal.kernel.exception.SystemException; 215 216 /** 217 * Returns the number of asset links. 218 * 219 * @return the number of asset links 220 * @throws SystemException if a system exception occurred 221 */ 222 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 223 public int getAssetLinksCount() 224 throws com.liferay.portal.kernel.exception.SystemException; 225 226 /** 227 * Updates the asset link in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 228 * 229 * @param assetLink the asset link 230 * @return the asset link that was updated 231 * @throws SystemException if a system exception occurred 232 */ 233 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 234 public com.liferay.portlet.asset.model.AssetLink updateAssetLink( 235 com.liferay.portlet.asset.model.AssetLink assetLink) 236 throws com.liferay.portal.kernel.exception.SystemException; 237 238 /** 239 * Returns the Spring bean ID for this bean. 240 * 241 * @return the Spring bean ID for this bean 242 */ 243 public java.lang.String getBeanIdentifier(); 244 245 /** 246 * Sets the Spring bean ID for this bean. 247 * 248 * @param beanIdentifier the Spring bean ID for this bean 249 */ 250 public void setBeanIdentifier(java.lang.String beanIdentifier); 251 252 /** 253 * Adds a new asset link. 254 * 255 * @param userId the primary key of the link's creator 256 * @param entryId1 the primary key of the first asset entry 257 * @param entryId2 the primary key of the second asset entry 258 * @param type the link type. Acceptable values include {@link 259 com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_RELATED} 260 which is a bidirectional relationship and {@link 261 com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_CHILD} 262 which is a unidirectional relationship. For more information see 263 {@link com.liferay.portlet.asset.model.AssetLinkConstants} 264 * @param weight the weight of the relationship, allowing precedence 265 ordering of links 266 * @return the asset link 267 * @throws PortalException if the user could not be found 268 * @throws SystemException if a system exception occurred 269 */ 270 public com.liferay.portlet.asset.model.AssetLink addLink(long userId, 271 long entryId1, long entryId2, int type, int weight) 272 throws com.liferay.portal.kernel.exception.PortalException, 273 com.liferay.portal.kernel.exception.SystemException; 274 275 /** 276 * Deletes the asset link. 277 * 278 * @param link the asset link 279 * @throws SystemException if a system exception occurred 280 */ 281 public void deleteLink(com.liferay.portlet.asset.model.AssetLink link) 282 throws com.liferay.portal.kernel.exception.SystemException; 283 284 /** 285 * Deletes the asset link. 286 * 287 * @param linkId the primary key of the asset link 288 * @throws PortalException if the asset link could not be found 289 * @throws SystemException if a system exception occurred 290 */ 291 public void deleteLink(long linkId) 292 throws com.liferay.portal.kernel.exception.PortalException, 293 com.liferay.portal.kernel.exception.SystemException; 294 295 /** 296 * Deletes all links associated with the asset entry. 297 * 298 * @param entryId the primary key of the asset entry 299 * @throws SystemException if a system exception occurred 300 */ 301 public void deleteLinks(long entryId) 302 throws com.liferay.portal.kernel.exception.SystemException; 303 304 /** 305 * Delete all links that associate the two asset entries. 306 * 307 * @param entryId1 the primary key of the first asset entry 308 * @param entryId2 the primary key of the second asset entry 309 * @throws SystemException if a system exception occurred 310 */ 311 public void deleteLinks(long entryId1, long entryId2) 312 throws com.liferay.portal.kernel.exception.SystemException; 313 314 /** 315 * Returns all the asset links whose first entry ID is the given entry ID. 316 * 317 * @param entryId the primary key of the asset entry 318 * @return the asset links whose first entry ID is the given entry ID 319 * @throws SystemException if a system exception occurred 320 */ 321 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 322 public java.util.List<com.liferay.portlet.asset.model.AssetLink> getDirectLinks( 323 long entryId) 324 throws com.liferay.portal.kernel.exception.SystemException; 325 326 /** 327 * Returns all the asset links of the given link type whose first entry ID 328 * is the given entry ID. 329 * 330 * @param entryId the primary key of the asset entry 331 * @param typeId the link type. Acceptable values include {@link 332 com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_RELATED} 333 which is a bidirectional relationship and {@link 334 com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_CHILD} 335 which is a unidirectional relationship. For more information see 336 {@link com.liferay.portlet.asset.model.AssetLinkConstants} 337 * @return the asset links of the given link type whose first entry ID is 338 the given entry ID 339 * @throws SystemException if a system exception occurred 340 */ 341 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 342 public java.util.List<com.liferay.portlet.asset.model.AssetLink> getDirectLinks( 343 long entryId, int typeId) 344 throws com.liferay.portal.kernel.exception.SystemException; 345 346 /** 347 * Returns all the asset links whose first or second entry ID is the given 348 * entry ID. 349 * 350 * @param entryId the primary key of the asset entry 351 * @return the asset links whose first or second entry ID is the given entry 352 ID 353 * @throws SystemException if a system exception occurred 354 */ 355 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 356 public java.util.List<com.liferay.portlet.asset.model.AssetLink> getLinks( 357 long entryId) 358 throws com.liferay.portal.kernel.exception.SystemException; 359 360 /** 361 * Returns all the asset links of the given link type whose first or second 362 * entry ID is the given entry ID. 363 * 364 * @param entryId the primary key of the asset entry 365 * @param typeId the link type. Acceptable values include {@link 366 com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_RELATED} 367 which is a bidirectional relationship and {@link 368 com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_CHILD} 369 which is a unidirectional relationship. For more information see 370 {@link com.liferay.portlet.asset.model.AssetLinkConstants} 371 * @return the asset links of the given link type whose first or second 372 entry ID is the given entry ID 373 * @throws SystemException if a system exception occurred 374 */ 375 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 376 public java.util.List<com.liferay.portlet.asset.model.AssetLink> getLinks( 377 long entryId, int typeId) 378 throws com.liferay.portal.kernel.exception.SystemException; 379 380 /** 381 * Returns all the asset links of the given link type whose second entry ID 382 * is the given entry ID. 383 * 384 * @param entryId the primary key of the asset entry 385 * @param typeId the link type. Acceptable values include {@link 386 com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_RELATED} 387 which is a bidirectional relationship and {@link 388 com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_CHILD} 389 which is a unidirectional relationship. For more information see 390 {@link com.liferay.portlet.asset.model.AssetLinkConstants} 391 * @return the asset links of the given link type whose second entry ID is 392 the given entry ID 393 * @throws SystemException if a system exception occurred 394 */ 395 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 396 public java.util.List<com.liferay.portlet.asset.model.AssetLink> getReverseLinks( 397 long entryId, int typeId) 398 throws com.liferay.portal.kernel.exception.SystemException; 399 400 public com.liferay.portlet.asset.model.AssetLink updateLink(long userId, 401 long entryId1, long entryId2, int typeId, int weight) 402 throws com.liferay.portal.kernel.exception.PortalException, 403 com.liferay.portal.kernel.exception.SystemException; 404 405 /** 406 * Updates all links of the asset entry, replacing them with links 407 * associating the asset entry with the asset entries of the given link 408 * entry IDs. 409 * 410 * <p> 411 * If no link exists with a given link entry ID, a new link is created 412 * associating the current asset entry with the asset entry of that link 413 * entry ID. An existing link is deleted if either of its entry IDs is not 414 * contained in the given link entry IDs. 415 * </p> 416 * 417 * @param userId the primary key of the user updating the links 418 * @param entryId the primary key of the asset entry to be managed 419 * @param linkEntryIds the primary keys of the asset entries to be linked 420 with the asset entry to be managed 421 * @param typeId the type of the asset links to be created. Acceptable 422 values include {@link 423 com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_RELATED} 424 which is a bidirectional relationship and {@link 425 com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_CHILD} 426 which is a unidirectional relationship. For more information see 427 {@link com.liferay.portlet.asset.model.AssetLinkConstants} 428 * @throws PortalException if the user could not be found 429 * @throws SystemException if a system exception occurred 430 */ 431 public void updateLinks(long userId, long entryId, long[] linkEntryIds, 432 int typeId) 433 throws com.liferay.portal.kernel.exception.PortalException, 434 com.liferay.portal.kernel.exception.SystemException; 435 }