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.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 public com.liferay.portal.model.WorkflowInstanceLink addWorkflowInstanceLink( 049 long userId, long companyId, long groupId, java.lang.String className, 050 long classPK, long workflowInstanceId) throws PortalException; 051 052 /** 053 * Adds the workflow instance link to the database. Also notifies the appropriate model listeners. 054 * 055 * @param workflowInstanceLink the workflow instance link 056 * @return the workflow instance link that was added 057 */ 058 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 059 public com.liferay.portal.model.WorkflowInstanceLink addWorkflowInstanceLink( 060 com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink); 061 062 /** 063 * Creates a new workflow instance link with the primary key. Does not add the workflow instance link to the database. 064 * 065 * @param workflowInstanceLinkId the primary key for the new workflow instance link 066 * @return the new workflow instance link 067 */ 068 public com.liferay.portal.model.WorkflowInstanceLink createWorkflowInstanceLink( 069 long workflowInstanceLinkId); 070 071 /** 072 * @throws PortalException 073 */ 074 @Override 075 public com.liferay.portal.model.PersistedModel deletePersistedModel( 076 com.liferay.portal.model.PersistedModel persistedModel) 077 throws PortalException; 078 079 public com.liferay.portal.model.WorkflowInstanceLink deleteWorkflowInstanceLink( 080 long companyId, long groupId, java.lang.String className, long classPK) 081 throws PortalException; 082 083 /** 084 * Deletes the workflow instance link from the database. Also notifies the appropriate model listeners. 085 * 086 * @param workflowInstanceLink the workflow instance link 087 * @return the workflow instance link that was removed 088 * @throws PortalException 089 */ 090 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 091 public com.liferay.portal.model.WorkflowInstanceLink deleteWorkflowInstanceLink( 092 com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink) 093 throws PortalException; 094 095 /** 096 * Deletes the workflow instance link with the primary key from the database. Also notifies the appropriate model listeners. 097 * 098 * @param workflowInstanceLinkId the primary key of the workflow instance link 099 * @return the workflow instance link that was removed 100 * @throws PortalException if a workflow instance link with the primary key could not be found 101 */ 102 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 103 public com.liferay.portal.model.WorkflowInstanceLink deleteWorkflowInstanceLink( 104 long workflowInstanceLinkId) throws PortalException; 105 106 public void deleteWorkflowInstanceLinks(long companyId, long groupId, 107 java.lang.String className, long classPK) throws PortalException; 108 109 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 110 111 /** 112 * Performs a dynamic query on the database and returns the matching rows. 113 * 114 * @param dynamicQuery the dynamic query 115 * @return the matching rows 116 */ 117 public <T> java.util.List<T> dynamicQuery( 118 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 119 120 /** 121 * Performs a dynamic query on the database and returns a range of the matching rows. 122 * 123 * <p> 124 * 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. 125 * </p> 126 * 127 * @param dynamicQuery the dynamic query 128 * @param start the lower bound of the range of model instances 129 * @param end the upper bound of the range of model instances (not inclusive) 130 * @return the range of matching rows 131 */ 132 public <T> java.util.List<T> dynamicQuery( 133 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 134 int end); 135 136 /** 137 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 138 * 139 * <p> 140 * 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. 141 * </p> 142 * 143 * @param dynamicQuery the dynamic query 144 * @param start the lower bound of the range of model instances 145 * @param end the upper bound of the range of model instances (not inclusive) 146 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 147 * @return the ordered range of matching rows 148 */ 149 public <T> java.util.List<T> dynamicQuery( 150 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 151 int end, 152 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 153 154 /** 155 * Returns the number of rows matching the dynamic query. 156 * 157 * @param dynamicQuery the dynamic query 158 * @return the number of rows matching the dynamic query 159 */ 160 public long dynamicQueryCount( 161 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 162 163 /** 164 * Returns the number of rows matching the dynamic query. 165 * 166 * @param dynamicQuery the dynamic query 167 * @param projection the projection to apply to the query 168 * @return the number of rows matching the dynamic query 169 */ 170 public long dynamicQueryCount( 171 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 172 com.liferay.portal.kernel.dao.orm.Projection projection); 173 174 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 175 public com.liferay.portal.model.WorkflowInstanceLink fetchWorkflowInstanceLink( 176 long companyId, long groupId, java.lang.String className, long classPK); 177 178 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 179 public com.liferay.portal.model.WorkflowInstanceLink fetchWorkflowInstanceLink( 180 long workflowInstanceLinkId); 181 182 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 183 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 184 185 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 186 public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery(); 187 188 /** 189 * Returns the OSGi service identifier. 190 * 191 * @return the OSGi service identifier 192 */ 193 public java.lang.String getOSGiServiceIdentifier(); 194 195 @Override 196 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 197 public com.liferay.portal.model.PersistedModel getPersistedModel( 198 java.io.Serializable primaryKeyObj) throws PortalException; 199 200 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 201 public java.lang.String getState(long companyId, long groupId, 202 java.lang.String className, long classPK) throws PortalException; 203 204 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 205 public com.liferay.portal.model.WorkflowInstanceLink getWorkflowInstanceLink( 206 long companyId, long groupId, java.lang.String className, long classPK) 207 throws PortalException; 208 209 /** 210 * Returns the workflow instance link with the primary key. 211 * 212 * @param workflowInstanceLinkId the primary key of the workflow instance link 213 * @return the workflow instance link 214 * @throws PortalException if a workflow instance link with the primary key could not be found 215 */ 216 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 217 public com.liferay.portal.model.WorkflowInstanceLink getWorkflowInstanceLink( 218 long workflowInstanceLinkId) throws PortalException; 219 220 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 221 public java.util.List<com.liferay.portal.model.WorkflowInstanceLink> getWorkflowInstanceLinks( 222 long companyId, long groupId, java.lang.String className, long classPK); 223 224 /** 225 * Returns a range of all the workflow instance links. 226 * 227 * <p> 228 * 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. 229 * </p> 230 * 231 * @param start the lower bound of the range of workflow instance links 232 * @param end the upper bound of the range of workflow instance links (not inclusive) 233 * @return the range of workflow instance links 234 */ 235 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 236 public java.util.List<com.liferay.portal.model.WorkflowInstanceLink> getWorkflowInstanceLinks( 237 int start, int end); 238 239 /** 240 * Returns the number of workflow instance links. 241 * 242 * @return the number of workflow instance links 243 */ 244 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 245 public int getWorkflowInstanceLinksCount(); 246 247 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 248 public boolean hasWorkflowInstanceLink(long companyId, long groupId, 249 java.lang.String className, long classPK); 250 251 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 252 public boolean isEnded(long companyId, long groupId, 253 java.lang.String className, long classPK) throws PortalException; 254 255 public void startWorkflowInstance(long companyId, long groupId, 256 long userId, java.lang.String className, long classPK, 257 java.util.Map<java.lang.String, java.io.Serializable> workflowContext) 258 throws PortalException; 259 260 public void updateClassPK(long companyId, long groupId, 261 java.lang.String className, long oldClassPK, long newClassPK) 262 throws PortalException; 263 264 /** 265 * Updates the workflow instance link in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 266 * 267 * @param workflowInstanceLink the workflow instance link 268 * @return the workflow instance link that was updated 269 */ 270 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 271 public com.liferay.portal.model.WorkflowInstanceLink updateWorkflowInstanceLink( 272 com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink); 273 }