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 link local service. 025 * 026 * <p> 027 * 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. 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 AssetLinkLocalServiceUtil 036 * @see com.liferay.portlet.asset.service.base.AssetLinkLocalServiceBaseImpl 037 * @see com.liferay.portlet.asset.service.impl.AssetLinkLocalServiceImpl 038 * @generated 039 */ 040 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 041 PortalException.class, SystemException.class}) 042 public interface AssetLinkLocalService { 043 /** 044 * Adds the asset link to the database. Also notifies the appropriate model listeners. 045 * 046 * @param assetLink the asset link to add 047 * @return the asset link that was added 048 * @throws SystemException if a system exception occurred 049 */ 050 public com.liferay.portlet.asset.model.AssetLink addAssetLink( 051 com.liferay.portlet.asset.model.AssetLink assetLink) 052 throws com.liferay.portal.kernel.exception.SystemException; 053 054 /** 055 * Creates a new asset link with the primary key. Does not add the asset link to the database. 056 * 057 * @param linkId the primary key for the new asset link 058 * @return the new asset link 059 */ 060 public com.liferay.portlet.asset.model.AssetLink createAssetLink( 061 long linkId); 062 063 /** 064 * Deletes the asset link with the primary key from the database. Also notifies the appropriate model listeners. 065 * 066 * @param linkId the primary key of the asset link to delete 067 * @throws PortalException if a asset link with the primary key could not be found 068 * @throws SystemException if a system exception occurred 069 */ 070 public void deleteAssetLink(long linkId) 071 throws com.liferay.portal.kernel.exception.PortalException, 072 com.liferay.portal.kernel.exception.SystemException; 073 074 /** 075 * Deletes the asset link from the database. Also notifies the appropriate model listeners. 076 * 077 * @param assetLink the asset link to delete 078 * @throws SystemException if a system exception occurred 079 */ 080 public void deleteAssetLink( 081 com.liferay.portlet.asset.model.AssetLink assetLink) 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 link with the primary key. 148 * 149 * @param linkId the primary key of the asset link to get 150 * @return the asset link 151 * @throws PortalException if a asset link 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.AssetLink getAssetLink(long linkId) 156 throws com.liferay.portal.kernel.exception.PortalException, 157 com.liferay.portal.kernel.exception.SystemException; 158 159 /** 160 * Gets a range of all the asset links. 161 * 162 * <p> 163 * 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. 164 * </p> 165 * 166 * @param start the lower bound of the range of asset links to return 167 * @param end the upper bound of the range of asset links to return (not inclusive) 168 * @return the range of asset links 169 * @throws SystemException if a system exception occurred 170 */ 171 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 172 public java.util.List<com.liferay.portlet.asset.model.AssetLink> getAssetLinks( 173 int start, int end) 174 throws com.liferay.portal.kernel.exception.SystemException; 175 176 /** 177 * Gets the number of asset links. 178 * 179 * @return the number of asset links 180 * @throws SystemException if a system exception occurred 181 */ 182 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 183 public int getAssetLinksCount() 184 throws com.liferay.portal.kernel.exception.SystemException; 185 186 /** 187 * Updates the asset link in the database. Also notifies the appropriate model listeners. 188 * 189 * @param assetLink the asset link to update 190 * @return the asset link that was updated 191 * @throws SystemException if a system exception occurred 192 */ 193 public com.liferay.portlet.asset.model.AssetLink updateAssetLink( 194 com.liferay.portlet.asset.model.AssetLink assetLink) 195 throws com.liferay.portal.kernel.exception.SystemException; 196 197 /** 198 * Updates the asset link in the database. Also notifies the appropriate model listeners. 199 * 200 * @param assetLink the asset link to update 201 * @param merge whether to merge the asset link 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. 202 * @return the asset link that was updated 203 * @throws SystemException if a system exception occurred 204 */ 205 public com.liferay.portlet.asset.model.AssetLink updateAssetLink( 206 com.liferay.portlet.asset.model.AssetLink assetLink, boolean merge) 207 throws com.liferay.portal.kernel.exception.SystemException; 208 209 public com.liferay.portlet.asset.model.AssetLink addLink(long userId, 210 long entryId1, long entryId2, int type, int weight) 211 throws com.liferay.portal.kernel.exception.PortalException, 212 com.liferay.portal.kernel.exception.SystemException; 213 214 public void deleteLink(long linkId) 215 throws com.liferay.portal.kernel.exception.PortalException, 216 com.liferay.portal.kernel.exception.SystemException; 217 218 public void deleteLinks(long entryId) 219 throws com.liferay.portal.kernel.exception.SystemException; 220 221 public void deleteLinks(long entryId1, long entryId2) 222 throws com.liferay.portal.kernel.exception.SystemException; 223 224 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 225 public java.util.List<com.liferay.portlet.asset.model.AssetLink> getLinks( 226 long entryId, int typeId) 227 throws com.liferay.portal.kernel.exception.SystemException; 228 229 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 230 public java.util.List<com.liferay.portlet.asset.model.AssetLink> getReverseLinks( 231 long entryId, int typeId) 232 throws com.liferay.portal.kernel.exception.SystemException; 233 }