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 com.liferay.portal.kernel.exception.PortalException; 018 import com.liferay.portal.kernel.exception.SystemException; 019 import com.liferay.portal.kernel.transaction.Isolation; 020 import com.liferay.portal.kernel.transaction.Propagation; 021 import com.liferay.portal.kernel.transaction.Transactional; 022 023 /** 024 * The interface for the workflow instance link local service. 025 * 026 * <p> 027 * 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. 028 * </p> 029 * 030 * @author Brian Wing Shun Chan 031 * @see WorkflowInstanceLinkLocalServiceUtil 032 * @see com.liferay.portal.service.base.WorkflowInstanceLinkLocalServiceBaseImpl 033 * @see com.liferay.portal.service.impl.WorkflowInstanceLinkLocalServiceImpl 034 * @generated 035 */ 036 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 037 PortalException.class, SystemException.class}) 038 public interface WorkflowInstanceLinkLocalService extends BaseLocalService, 039 PersistedModelLocalService { 040 /* 041 * NOTE FOR DEVELOPERS: 042 * 043 * 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. 044 */ 045 046 /** 047 * Adds the workflow instance link to the database. Also notifies the appropriate model listeners. 048 * 049 * @param workflowInstanceLink the workflow instance link 050 * @return the workflow instance link that was added 051 * @throws SystemException if a system exception occurred 052 */ 053 public com.liferay.portal.model.WorkflowInstanceLink addWorkflowInstanceLink( 054 com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink) 055 throws com.liferay.portal.kernel.exception.SystemException; 056 057 /** 058 * Creates a new workflow instance link with the primary key. Does not add the workflow instance link to the database. 059 * 060 * @param workflowInstanceLinkId the primary key for the new workflow instance link 061 * @return the new workflow instance link 062 */ 063 public com.liferay.portal.model.WorkflowInstanceLink createWorkflowInstanceLink( 064 long workflowInstanceLinkId); 065 066 /** 067 * Deletes the workflow instance link with the primary key from the database. Also notifies the appropriate model listeners. 068 * 069 * @param workflowInstanceLinkId the primary key of the workflow instance link 070 * @return the workflow instance link that was removed 071 * @throws PortalException if a workflow instance link with the primary key could not be found 072 * @throws SystemException if a system exception occurred 073 */ 074 public com.liferay.portal.model.WorkflowInstanceLink deleteWorkflowInstanceLink( 075 long workflowInstanceLinkId) 076 throws com.liferay.portal.kernel.exception.PortalException, 077 com.liferay.portal.kernel.exception.SystemException; 078 079 /** 080 * Deletes the workflow instance link from the database. Also notifies the appropriate model listeners. 081 * 082 * @param workflowInstanceLink the workflow instance link 083 * @return the workflow instance link that was removed 084 * @throws PortalException 085 * @throws SystemException if a system exception occurred 086 */ 087 public com.liferay.portal.model.WorkflowInstanceLink deleteWorkflowInstanceLink( 088 com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink) 089 throws com.liferay.portal.kernel.exception.PortalException, 090 com.liferay.portal.kernel.exception.SystemException; 091 092 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 093 094 /** 095 * Performs a dynamic query on the database and returns the matching rows. 096 * 097 * @param dynamicQuery the dynamic query 098 * @return the matching rows 099 * @throws SystemException if a system exception occurred 100 */ 101 @SuppressWarnings("rawtypes") 102 public java.util.List dynamicQuery( 103 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 104 throws com.liferay.portal.kernel.exception.SystemException; 105 106 /** 107 * Performs a dynamic query on the database and returns a range of the matching rows. 108 * 109 * <p> 110 * 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. 111 * </p> 112 * 113 * @param dynamicQuery the dynamic query 114 * @param start the lower bound of the range of model instances 115 * @param end the upper bound of the range of model instances (not inclusive) 116 * @return the range of matching rows 117 * @throws SystemException if a system exception occurred 118 */ 119 @SuppressWarnings("rawtypes") 120 public java.util.List dynamicQuery( 121 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 122 int end) throws com.liferay.portal.kernel.exception.SystemException; 123 124 /** 125 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 126 * 127 * <p> 128 * 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. 129 * </p> 130 * 131 * @param dynamicQuery the dynamic query 132 * @param start the lower bound of the range of model instances 133 * @param end the upper bound of the range of model instances (not inclusive) 134 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 135 * @return the ordered range of matching rows 136 * @throws SystemException if a system exception occurred 137 */ 138 @SuppressWarnings("rawtypes") 139 public java.util.List dynamicQuery( 140 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 141 int end, 142 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 143 throws com.liferay.portal.kernel.exception.SystemException; 144 145 /** 146 * Returns the number of rows that match the dynamic query. 147 * 148 * @param dynamicQuery the dynamic query 149 * @return the number of rows that match the dynamic query 150 * @throws SystemException if a system exception occurred 151 */ 152 public long dynamicQueryCount( 153 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 154 throws com.liferay.portal.kernel.exception.SystemException; 155 156 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 157 public com.liferay.portal.model.WorkflowInstanceLink fetchWorkflowInstanceLink( 158 long workflowInstanceLinkId) 159 throws com.liferay.portal.kernel.exception.SystemException; 160 161 /** 162 * Returns the workflow instance link with the primary key. 163 * 164 * @param workflowInstanceLinkId the primary key of the workflow instance link 165 * @return the workflow instance link 166 * @throws PortalException if a workflow instance link with the primary key could not be found 167 * @throws SystemException if a system exception occurred 168 */ 169 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 170 public com.liferay.portal.model.WorkflowInstanceLink getWorkflowInstanceLink( 171 long workflowInstanceLinkId) 172 throws com.liferay.portal.kernel.exception.PortalException, 173 com.liferay.portal.kernel.exception.SystemException; 174 175 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 176 public com.liferay.portal.model.PersistedModel getPersistedModel( 177 java.io.Serializable primaryKeyObj) 178 throws com.liferay.portal.kernel.exception.PortalException, 179 com.liferay.portal.kernel.exception.SystemException; 180 181 /** 182 * Returns a range of all the workflow instance links. 183 * 184 * <p> 185 * 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. 186 * </p> 187 * 188 * @param start the lower bound of the range of workflow instance links 189 * @param end the upper bound of the range of workflow instance links (not inclusive) 190 * @return the range of workflow instance links 191 * @throws SystemException if a system exception occurred 192 */ 193 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 194 public java.util.List<com.liferay.portal.model.WorkflowInstanceLink> getWorkflowInstanceLinks( 195 int start, int end) 196 throws com.liferay.portal.kernel.exception.SystemException; 197 198 /** 199 * Returns the number of workflow instance links. 200 * 201 * @return the number of workflow instance links 202 * @throws SystemException if a system exception occurred 203 */ 204 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 205 public int getWorkflowInstanceLinksCount() 206 throws com.liferay.portal.kernel.exception.SystemException; 207 208 /** 209 * Updates the workflow instance link in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 210 * 211 * @param workflowInstanceLink the workflow instance link 212 * @return the workflow instance link that was updated 213 * @throws SystemException if a system exception occurred 214 */ 215 public com.liferay.portal.model.WorkflowInstanceLink updateWorkflowInstanceLink( 216 com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink) 217 throws com.liferay.portal.kernel.exception.SystemException; 218 219 /** 220 * Updates the workflow instance link in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 221 * 222 * @param workflowInstanceLink the workflow instance link 223 * @param merge whether to merge the workflow instance 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. 224 * @return the workflow instance link that was updated 225 * @throws SystemException if a system exception occurred 226 */ 227 public com.liferay.portal.model.WorkflowInstanceLink updateWorkflowInstanceLink( 228 com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink, 229 boolean merge) 230 throws com.liferay.portal.kernel.exception.SystemException; 231 232 /** 233 * Returns the Spring bean ID for this bean. 234 * 235 * @return the Spring bean ID for this bean 236 */ 237 public java.lang.String getBeanIdentifier(); 238 239 /** 240 * Sets the Spring bean ID for this bean. 241 * 242 * @param beanIdentifier the Spring bean ID for this bean 243 */ 244 public void setBeanIdentifier(java.lang.String beanIdentifier); 245 246 public com.liferay.portal.model.WorkflowInstanceLink addWorkflowInstanceLink( 247 long userId, long companyId, long groupId, java.lang.String className, 248 long classPK, long workflowInstanceId) 249 throws com.liferay.portal.kernel.exception.PortalException, 250 com.liferay.portal.kernel.exception.SystemException; 251 252 public void deleteWorkflowInstanceLink(long companyId, long groupId, 253 java.lang.String className, long classPK) 254 throws com.liferay.portal.kernel.exception.PortalException, 255 com.liferay.portal.kernel.exception.SystemException; 256 257 public void deleteWorkflowInstanceLinks(long companyId, long groupId, 258 java.lang.String className, long classPK) 259 throws com.liferay.portal.kernel.exception.PortalException, 260 com.liferay.portal.kernel.exception.SystemException; 261 262 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 263 public com.liferay.portal.model.WorkflowInstanceLink fetchWorkflowInstanceLink( 264 long companyId, long groupId, java.lang.String className, long classPK) 265 throws com.liferay.portal.kernel.exception.SystemException; 266 267 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 268 public java.lang.String getState(long companyId, long groupId, 269 java.lang.String className, long classPK) 270 throws com.liferay.portal.kernel.exception.PortalException, 271 com.liferay.portal.kernel.exception.SystemException; 272 273 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 274 public com.liferay.portal.model.WorkflowInstanceLink getWorkflowInstanceLink( 275 long companyId, long groupId, java.lang.String className, long classPK) 276 throws com.liferay.portal.kernel.exception.PortalException, 277 com.liferay.portal.kernel.exception.SystemException; 278 279 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 280 public java.util.List<com.liferay.portal.model.WorkflowInstanceLink> getWorkflowInstanceLinks( 281 long companyId, long groupId, java.lang.String className, long classPK) 282 throws com.liferay.portal.kernel.exception.SystemException; 283 284 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 285 public boolean hasWorkflowInstanceLink(long companyId, long groupId, 286 java.lang.String className, long classPK) 287 throws com.liferay.portal.kernel.exception.SystemException; 288 289 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 290 public boolean isEnded(long companyId, long groupId, 291 java.lang.String className, long classPK) 292 throws com.liferay.portal.kernel.exception.PortalException, 293 com.liferay.portal.kernel.exception.SystemException; 294 295 public void startWorkflowInstance(long companyId, long groupId, 296 long userId, java.lang.String className, long classPK, 297 java.util.Map<java.lang.String, java.io.Serializable> workflowContext) 298 throws com.liferay.portal.kernel.exception.PortalException, 299 com.liferay.portal.kernel.exception.SystemException; 300 301 public void updateClassPK(long companyId, long groupId, 302 java.lang.String className, long oldClassPK, long newClassPK) 303 throws com.liferay.portal.kernel.exception.PortalException, 304 com.liferay.portal.kernel.exception.SystemException; 305 }