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