001 /** 002 * Copyright (c) 2000-2012 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 039 extends 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 * @throws PortalException if a workflow instance link with the primary key could not be found 071 * @throws SystemException if a system exception occurred 072 */ 073 public void deleteWorkflowInstanceLink(long workflowInstanceLinkId) 074 throws com.liferay.portal.kernel.exception.PortalException, 075 com.liferay.portal.kernel.exception.SystemException; 076 077 /** 078 * Deletes the workflow instance link from the database. Also notifies the appropriate model listeners. 079 * 080 * @param workflowInstanceLink the workflow instance link 081 * @throws SystemException if a system exception occurred 082 */ 083 public void deleteWorkflowInstanceLink( 084 com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink) 085 throws com.liferay.portal.kernel.exception.SystemException; 086 087 /** 088 * Performs a dynamic query on the database and returns the matching rows. 089 * 090 * @param dynamicQuery the dynamic query 091 * @return the matching rows 092 * @throws SystemException if a system exception occurred 093 */ 094 @SuppressWarnings("rawtypes") 095 public java.util.List dynamicQuery( 096 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 097 throws com.liferay.portal.kernel.exception.SystemException; 098 099 /** 100 * Performs a dynamic query on the database and returns a range of the matching rows. 101 * 102 * <p> 103 * 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. 104 * </p> 105 * 106 * @param dynamicQuery the dynamic query 107 * @param start the lower bound of the range of model instances 108 * @param end the upper bound of the range of model instances (not inclusive) 109 * @return the range of matching rows 110 * @throws SystemException if a system exception occurred 111 */ 112 @SuppressWarnings("rawtypes") 113 public java.util.List dynamicQuery( 114 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 115 int end) throws com.liferay.portal.kernel.exception.SystemException; 116 117 /** 118 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 119 * 120 * <p> 121 * 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. 122 * </p> 123 * 124 * @param dynamicQuery the dynamic query 125 * @param start the lower bound of the range of model instances 126 * @param end the upper bound of the range of model instances (not inclusive) 127 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 128 * @return the ordered range of matching rows 129 * @throws SystemException if a system exception occurred 130 */ 131 @SuppressWarnings("rawtypes") 132 public java.util.List dynamicQuery( 133 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 134 int end, 135 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 136 throws com.liferay.portal.kernel.exception.SystemException; 137 138 /** 139 * Returns the number of rows that match the dynamic query. 140 * 141 * @param dynamicQuery the dynamic query 142 * @return the number of rows that match the dynamic query 143 * @throws SystemException if a system exception occurred 144 */ 145 public long dynamicQueryCount( 146 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 147 throws com.liferay.portal.kernel.exception.SystemException; 148 149 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 150 public com.liferay.portal.model.WorkflowInstanceLink fetchWorkflowInstanceLink( 151 long workflowInstanceLinkId) 152 throws com.liferay.portal.kernel.exception.SystemException; 153 154 /** 155 * Returns the workflow instance link with the primary key. 156 * 157 * @param workflowInstanceLinkId the primary key of the workflow instance link 158 * @return the workflow instance link 159 * @throws PortalException if a workflow instance link with the primary key could not be found 160 * @throws SystemException if a system exception occurred 161 */ 162 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 163 public com.liferay.portal.model.WorkflowInstanceLink getWorkflowInstanceLink( 164 long workflowInstanceLinkId) 165 throws com.liferay.portal.kernel.exception.PortalException, 166 com.liferay.portal.kernel.exception.SystemException; 167 168 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 169 public com.liferay.portal.model.PersistedModel getPersistedModel( 170 java.io.Serializable primaryKeyObj) 171 throws com.liferay.portal.kernel.exception.PortalException, 172 com.liferay.portal.kernel.exception.SystemException; 173 174 /** 175 * Returns a range of all the workflow instance links. 176 * 177 * <p> 178 * 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. 179 * </p> 180 * 181 * @param start the lower bound of the range of workflow instance links 182 * @param end the upper bound of the range of workflow instance links (not inclusive) 183 * @return the range of workflow instance links 184 * @throws SystemException if a system exception occurred 185 */ 186 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 187 public java.util.List<com.liferay.portal.model.WorkflowInstanceLink> getWorkflowInstanceLinks( 188 int start, int end) 189 throws com.liferay.portal.kernel.exception.SystemException; 190 191 /** 192 * Returns the number of workflow instance links. 193 * 194 * @return the number of workflow instance links 195 * @throws SystemException if a system exception occurred 196 */ 197 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 198 public int getWorkflowInstanceLinksCount() 199 throws com.liferay.portal.kernel.exception.SystemException; 200 201 /** 202 * Updates the workflow instance link in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 203 * 204 * @param workflowInstanceLink the workflow instance link 205 * @return the workflow instance link that was updated 206 * @throws SystemException if a system exception occurred 207 */ 208 public com.liferay.portal.model.WorkflowInstanceLink updateWorkflowInstanceLink( 209 com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink) 210 throws com.liferay.portal.kernel.exception.SystemException; 211 212 /** 213 * Updates the workflow instance link in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 214 * 215 * @param workflowInstanceLink the workflow instance link 216 * @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. 217 * @return the workflow instance link that was updated 218 * @throws SystemException if a system exception occurred 219 */ 220 public com.liferay.portal.model.WorkflowInstanceLink updateWorkflowInstanceLink( 221 com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink, 222 boolean merge) 223 throws com.liferay.portal.kernel.exception.SystemException; 224 225 /** 226 * Returns the Spring bean ID for this bean. 227 * 228 * @return the Spring bean ID for this bean 229 */ 230 public java.lang.String getBeanIdentifier(); 231 232 /** 233 * Sets the Spring bean ID for this bean. 234 * 235 * @param beanIdentifier the Spring bean ID for this bean 236 */ 237 public void setBeanIdentifier(java.lang.String beanIdentifier); 238 239 public com.liferay.portal.model.WorkflowInstanceLink addWorkflowInstanceLink( 240 long userId, long companyId, long groupId, java.lang.String className, 241 long classPK, long workflowInstanceId) 242 throws com.liferay.portal.kernel.exception.PortalException, 243 com.liferay.portal.kernel.exception.SystemException; 244 245 public void deleteWorkflowInstanceLink(long companyId, long groupId, 246 java.lang.String className, long classPK) 247 throws com.liferay.portal.kernel.exception.PortalException, 248 com.liferay.portal.kernel.exception.SystemException; 249 250 public void deleteWorkflowInstanceLinks(long companyId, long groupId, 251 java.lang.String className, long classPK) 252 throws com.liferay.portal.kernel.exception.PortalException, 253 com.liferay.portal.kernel.exception.SystemException; 254 255 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 256 public com.liferay.portal.model.WorkflowInstanceLink fetchWorkflowInstanceLink( 257 long companyId, long groupId, java.lang.String className, long classPK) 258 throws com.liferay.portal.kernel.exception.SystemException; 259 260 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 261 public java.lang.String getState(long companyId, long groupId, 262 java.lang.String className, long classPK) 263 throws com.liferay.portal.kernel.exception.PortalException, 264 com.liferay.portal.kernel.exception.SystemException; 265 266 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 267 public com.liferay.portal.model.WorkflowInstanceLink getWorkflowInstanceLink( 268 long companyId, long groupId, java.lang.String className, long classPK) 269 throws com.liferay.portal.kernel.exception.PortalException, 270 com.liferay.portal.kernel.exception.SystemException; 271 272 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 273 public java.util.List<com.liferay.portal.model.WorkflowInstanceLink> getWorkflowInstanceLinks( 274 long companyId, long groupId, java.lang.String className, long classPK) 275 throws com.liferay.portal.kernel.exception.SystemException; 276 277 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 278 public boolean hasWorkflowInstanceLink(long companyId, long groupId, 279 java.lang.String className, long classPK) 280 throws com.liferay.portal.kernel.exception.SystemException; 281 282 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 283 public boolean isEnded(long companyId, long groupId, 284 java.lang.String className, long classPK) 285 throws com.liferay.portal.kernel.exception.PortalException, 286 com.liferay.portal.kernel.exception.SystemException; 287 288 public void startWorkflowInstance(long companyId, long groupId, 289 long userId, java.lang.String className, long classPK, 290 java.util.Map<java.lang.String, java.io.Serializable> workflowContext) 291 throws com.liferay.portal.kernel.exception.PortalException, 292 com.liferay.portal.kernel.exception.SystemException; 293 294 public void updateClassPK(long companyId, long groupId, 295 java.lang.String className, long oldClassPK, long newClassPK) 296 throws com.liferay.portal.kernel.exception.PortalException, 297 com.liferay.portal.kernel.exception.SystemException; 298 }