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.portal.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 026 /** 027 * Provides the local service interface for WorkflowInstanceLink. Methods of this 028 * service will not have security checks based on the propagated JAAS 029 * credentials because this service can only be accessed from within the same 030 * VM. 031 * 032 * @author Brian Wing Shun Chan 033 * @see WorkflowInstanceLinkLocalServiceUtil 034 * @see com.liferay.portal.service.base.WorkflowInstanceLinkLocalServiceBaseImpl 035 * @see com.liferay.portal.service.impl.WorkflowInstanceLinkLocalServiceImpl 036 * @generated 037 */ 038 @ProviderType 039 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 040 PortalException.class, SystemException.class}) 041 public interface WorkflowInstanceLinkLocalService extends BaseLocalService, 042 PersistedModelLocalService { 043 /* 044 * NOTE FOR DEVELOPERS: 045 * 046 * Never modify or reference this interface directly. Always use {@link WorkflowInstanceLinkLocalServiceUtil} to access the workflow instance link local service. Add custom service methods to {@link com.liferay.portal.service.impl.WorkflowInstanceLinkLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 047 */ 048 049 /** 050 * Adds the workflow instance link to the database. Also notifies the appropriate model listeners. 051 * 052 * @param workflowInstanceLink the workflow instance link 053 * @return the workflow instance link that was added 054 * @throws SystemException if a system exception occurred 055 */ 056 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 057 public com.liferay.portal.model.WorkflowInstanceLink addWorkflowInstanceLink( 058 com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink) 059 throws com.liferay.portal.kernel.exception.SystemException; 060 061 /** 062 * Creates a new workflow instance link with the primary key. Does not add the workflow instance link to the database. 063 * 064 * @param workflowInstanceLinkId the primary key for the new workflow instance link 065 * @return the new workflow instance link 066 */ 067 public com.liferay.portal.model.WorkflowInstanceLink createWorkflowInstanceLink( 068 long workflowInstanceLinkId); 069 070 /** 071 * Deletes the workflow instance link with the primary key from the database. Also notifies the appropriate model listeners. 072 * 073 * @param workflowInstanceLinkId the primary key of the workflow instance link 074 * @return the workflow instance link that was removed 075 * @throws PortalException if a workflow instance link with the primary key could not be found 076 * @throws SystemException if a system exception occurred 077 */ 078 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 079 public com.liferay.portal.model.WorkflowInstanceLink deleteWorkflowInstanceLink( 080 long workflowInstanceLinkId) 081 throws com.liferay.portal.kernel.exception.PortalException, 082 com.liferay.portal.kernel.exception.SystemException; 083 084 /** 085 * Deletes the workflow instance link from the database. Also notifies the appropriate model listeners. 086 * 087 * @param workflowInstanceLink the workflow instance link 088 * @return the workflow instance link that was removed 089 * @throws PortalException 090 * @throws SystemException if a system exception occurred 091 */ 092 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 093 public com.liferay.portal.model.WorkflowInstanceLink deleteWorkflowInstanceLink( 094 com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink) 095 throws com.liferay.portal.kernel.exception.PortalException, 096 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.portal.model.impl.WorkflowInstanceLinkModelImpl}. 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.portal.model.impl.WorkflowInstanceLinkModelImpl}. 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.portal.model.WorkflowInstanceLink fetchWorkflowInstanceLink( 177 long workflowInstanceLinkId) 178 throws com.liferay.portal.kernel.exception.SystemException; 179 180 /** 181 * Returns the workflow instance link with the primary key. 182 * 183 * @param workflowInstanceLinkId the primary key of the workflow instance link 184 * @return the workflow instance link 185 * @throws PortalException if a workflow instance link with the primary key could not be found 186 * @throws SystemException if a system exception occurred 187 */ 188 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 189 public com.liferay.portal.model.WorkflowInstanceLink getWorkflowInstanceLink( 190 long workflowInstanceLinkId) 191 throws com.liferay.portal.kernel.exception.PortalException, 192 com.liferay.portal.kernel.exception.SystemException; 193 194 @Override 195 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 196 public com.liferay.portal.model.PersistedModel getPersistedModel( 197 java.io.Serializable primaryKeyObj) 198 throws com.liferay.portal.kernel.exception.PortalException, 199 com.liferay.portal.kernel.exception.SystemException; 200 201 /** 202 * Returns a range of all the workflow instance links. 203 * 204 * <p> 205 * 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.portal.model.impl.WorkflowInstanceLinkModelImpl}. 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. 206 * </p> 207 * 208 * @param start the lower bound of the range of workflow instance links 209 * @param end the upper bound of the range of workflow instance links (not inclusive) 210 * @return the range of workflow instance links 211 * @throws SystemException if a system exception occurred 212 */ 213 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 214 public java.util.List<com.liferay.portal.model.WorkflowInstanceLink> getWorkflowInstanceLinks( 215 int start, int end) 216 throws com.liferay.portal.kernel.exception.SystemException; 217 218 /** 219 * Returns the number of workflow instance links. 220 * 221 * @return the number of workflow instance links 222 * @throws SystemException if a system exception occurred 223 */ 224 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 225 public int getWorkflowInstanceLinksCount() 226 throws com.liferay.portal.kernel.exception.SystemException; 227 228 /** 229 * Updates the workflow instance link in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 230 * 231 * @param workflowInstanceLink the workflow instance link 232 * @return the workflow instance link that was updated 233 * @throws SystemException if a system exception occurred 234 */ 235 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 236 public com.liferay.portal.model.WorkflowInstanceLink updateWorkflowInstanceLink( 237 com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink) 238 throws com.liferay.portal.kernel.exception.SystemException; 239 240 /** 241 * Returns the Spring bean ID for this bean. 242 * 243 * @return the Spring bean ID for this bean 244 */ 245 public java.lang.String getBeanIdentifier(); 246 247 /** 248 * Sets the Spring bean ID for this bean. 249 * 250 * @param beanIdentifier the Spring bean ID for this bean 251 */ 252 public void setBeanIdentifier(java.lang.String beanIdentifier); 253 254 public com.liferay.portal.model.WorkflowInstanceLink addWorkflowInstanceLink( 255 long userId, long companyId, long groupId, java.lang.String className, 256 long classPK, long workflowInstanceId) 257 throws com.liferay.portal.kernel.exception.PortalException, 258 com.liferay.portal.kernel.exception.SystemException; 259 260 public com.liferay.portal.model.WorkflowInstanceLink deleteWorkflowInstanceLink( 261 long companyId, long groupId, java.lang.String className, long classPK) 262 throws com.liferay.portal.kernel.exception.PortalException, 263 com.liferay.portal.kernel.exception.SystemException; 264 265 public void deleteWorkflowInstanceLinks(long companyId, long groupId, 266 java.lang.String className, long classPK) 267 throws com.liferay.portal.kernel.exception.PortalException, 268 com.liferay.portal.kernel.exception.SystemException; 269 270 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 271 public com.liferay.portal.model.WorkflowInstanceLink fetchWorkflowInstanceLink( 272 long companyId, long groupId, java.lang.String className, long classPK) 273 throws com.liferay.portal.kernel.exception.SystemException; 274 275 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 276 public java.lang.String getState(long companyId, long groupId, 277 java.lang.String className, long classPK) 278 throws com.liferay.portal.kernel.exception.PortalException, 279 com.liferay.portal.kernel.exception.SystemException; 280 281 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 282 public com.liferay.portal.model.WorkflowInstanceLink getWorkflowInstanceLink( 283 long companyId, long groupId, java.lang.String className, long classPK) 284 throws com.liferay.portal.kernel.exception.PortalException, 285 com.liferay.portal.kernel.exception.SystemException; 286 287 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 288 public java.util.List<com.liferay.portal.model.WorkflowInstanceLink> getWorkflowInstanceLinks( 289 long companyId, long groupId, java.lang.String className, long classPK) 290 throws com.liferay.portal.kernel.exception.SystemException; 291 292 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 293 public boolean hasWorkflowInstanceLink(long companyId, long groupId, 294 java.lang.String className, long classPK) 295 throws com.liferay.portal.kernel.exception.SystemException; 296 297 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 298 public boolean isEnded(long companyId, long groupId, 299 java.lang.String className, long classPK) 300 throws com.liferay.portal.kernel.exception.PortalException, 301 com.liferay.portal.kernel.exception.SystemException; 302 303 public void startWorkflowInstance(long companyId, long groupId, 304 long userId, java.lang.String className, long classPK, 305 java.util.Map<java.lang.String, java.io.Serializable> workflowContext) 306 throws com.liferay.portal.kernel.exception.PortalException, 307 com.liferay.portal.kernel.exception.SystemException; 308 309 public void updateClassPK(long companyId, long groupId, 310 java.lang.String className, long oldClassPK, long newClassPK) 311 throws com.liferay.portal.kernel.exception.PortalException, 312 com.liferay.portal.kernel.exception.SystemException; 313 }