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.dynamicdatamapping.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 DDMStorageLink. 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 DDMStorageLinkLocalServiceUtil 036 * @see com.liferay.portlet.dynamicdatamapping.service.base.DDMStorageLinkLocalServiceBaseImpl 037 * @see com.liferay.portlet.dynamicdatamapping.service.impl.DDMStorageLinkLocalServiceImpl 038 * @generated 039 */ 040 @ProviderType 041 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 042 PortalException.class, SystemException.class}) 043 public interface DDMStorageLinkLocalService extends BaseLocalService, 044 PersistedModelLocalService { 045 /* 046 * NOTE FOR DEVELOPERS: 047 * 048 * Never modify or reference this interface directly. Always use {@link DDMStorageLinkLocalServiceUtil} to access the d d m storage link local service. Add custom service methods to {@link com.liferay.portlet.dynamicdatamapping.service.impl.DDMStorageLinkLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 049 */ 050 051 /** 052 * Adds the d d m storage link to the database. Also notifies the appropriate model listeners. 053 * 054 * @param ddmStorageLink the d d m storage link 055 * @return the d d m storage link that was added 056 */ 057 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 058 public com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink addDDMStorageLink( 059 com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink ddmStorageLink); 060 061 public com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink addStorageLink( 062 long classNameId, long classPK, long structureId, 063 com.liferay.portal.service.ServiceContext serviceContext); 064 065 /** 066 * Creates a new d d m storage link with the primary key. Does not add the d d m storage link to the database. 067 * 068 * @param storageLinkId the primary key for the new d d m storage link 069 * @return the new d d m storage link 070 */ 071 public com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink createDDMStorageLink( 072 long storageLinkId); 073 074 public void deleteClassStorageLink(long classPK); 075 076 /** 077 * Deletes the d d m storage link from the database. Also notifies the appropriate model listeners. 078 * 079 * @param ddmStorageLink the d d m storage link 080 * @return the d d m storage link that was removed 081 */ 082 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 083 public com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink deleteDDMStorageLink( 084 com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink ddmStorageLink); 085 086 /** 087 * Deletes the d d m storage link with the primary key from the database. Also notifies the appropriate model listeners. 088 * 089 * @param storageLinkId the primary key of the d d m storage link 090 * @return the d d m storage link that was removed 091 * @throws PortalException if a d d m storage link with the primary key could not be found 092 */ 093 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 094 public com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink deleteDDMStorageLink( 095 long storageLinkId) throws PortalException; 096 097 /** 098 * @throws PortalException 099 */ 100 @Override 101 public com.liferay.portal.model.PersistedModel deletePersistedModel( 102 com.liferay.portal.model.PersistedModel persistedModel) 103 throws PortalException; 104 105 public void deleteStorageLink( 106 com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink storageLink); 107 108 public void deleteStorageLink(long storageLinkId); 109 110 public void deleteStructureStorageLinks(long structureId); 111 112 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 113 114 /** 115 * Performs a dynamic query on the database and returns the matching rows. 116 * 117 * @param dynamicQuery the dynamic query 118 * @return the matching rows 119 */ 120 public <T> java.util.List<T> dynamicQuery( 121 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 122 123 /** 124 * Performs a dynamic query on the database and returns a range of the matching rows. 125 * 126 * <p> 127 * 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.dynamicdatamapping.model.impl.DDMStorageLinkModelImpl}. 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. 128 * </p> 129 * 130 * @param dynamicQuery the dynamic query 131 * @param start the lower bound of the range of model instances 132 * @param end the upper bound of the range of model instances (not inclusive) 133 * @return the range of matching rows 134 */ 135 public <T> java.util.List<T> dynamicQuery( 136 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 137 int end); 138 139 /** 140 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 141 * 142 * <p> 143 * 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.dynamicdatamapping.model.impl.DDMStorageLinkModelImpl}. 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. 144 * </p> 145 * 146 * @param dynamicQuery the dynamic query 147 * @param start the lower bound of the range of model instances 148 * @param end the upper bound of the range of model instances (not inclusive) 149 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 150 * @return the ordered range of matching rows 151 */ 152 public <T> java.util.List<T> dynamicQuery( 153 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 154 int end, 155 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 156 157 /** 158 * Returns the number of rows matching the dynamic query. 159 * 160 * @param dynamicQuery the dynamic query 161 * @return the number of rows matching the dynamic query 162 */ 163 public long dynamicQueryCount( 164 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 165 166 /** 167 * Returns the number of rows matching the dynamic query. 168 * 169 * @param dynamicQuery the dynamic query 170 * @param projection the projection to apply to the query 171 * @return the number of rows matching the dynamic query 172 */ 173 public long dynamicQueryCount( 174 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 175 com.liferay.portal.kernel.dao.orm.Projection projection); 176 177 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 178 public com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink fetchDDMStorageLink( 179 long storageLinkId); 180 181 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 182 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 183 184 /** 185 * Returns the Spring bean ID for this bean. 186 * 187 * @return the Spring bean ID for this bean 188 */ 189 public java.lang.String getBeanIdentifier(); 190 191 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 192 public com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink getClassStorageLink( 193 long classPK) throws PortalException; 194 195 /** 196 * Returns the d d m storage link with the primary key. 197 * 198 * @param storageLinkId the primary key of the d d m storage link 199 * @return the d d m storage link 200 * @throws PortalException if a d d m storage link with the primary key could not be found 201 */ 202 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 203 public com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink getDDMStorageLink( 204 long storageLinkId) throws PortalException; 205 206 /** 207 * Returns a range of all the d d m storage links. 208 * 209 * <p> 210 * 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.dynamicdatamapping.model.impl.DDMStorageLinkModelImpl}. 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. 211 * </p> 212 * 213 * @param start the lower bound of the range of d d m storage links 214 * @param end the upper bound of the range of d d m storage links (not inclusive) 215 * @return the range of d d m storage links 216 */ 217 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 218 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink> getDDMStorageLinks( 219 int start, int end); 220 221 /** 222 * Returns the number of d d m storage links. 223 * 224 * @return the number of d d m storage links 225 */ 226 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 227 public int getDDMStorageLinksCount(); 228 229 @Override 230 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 231 public com.liferay.portal.model.PersistedModel getPersistedModel( 232 java.io.Serializable primaryKeyObj) throws PortalException; 233 234 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 235 public com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink getStorageLink( 236 long storageLinkId) throws PortalException; 237 238 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 239 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink> getStructureStorageLinks( 240 long structureId); 241 242 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 243 public int getStructureStorageLinksCount(long structureId); 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 * Updates the d d m storage link in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 254 * 255 * @param ddmStorageLink the d d m storage link 256 * @return the d d m storage link that was updated 257 */ 258 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 259 public com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink updateDDMStorageLink( 260 com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink ddmStorageLink); 261 262 public com.liferay.portlet.dynamicdatamapping.model.DDMStorageLink updateStorageLink( 263 long storageLinkId, long classNameId, long classPK) 264 throws PortalException; 265 }