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 * Provides the local service interface for WorkflowInstanceLink. Methods of this 025 * service will not have security checks based on the propagated JAAS 026 * credentials because this service can only be accessed from within the same 027 * VM. 028 * 029 * @author Brian Wing Shun Chan 030 * @see WorkflowInstanceLinkLocalServiceUtil 031 * @see com.liferay.portal.service.base.WorkflowInstanceLinkLocalServiceBaseImpl 032 * @see com.liferay.portal.service.impl.WorkflowInstanceLinkLocalServiceImpl 033 * @generated 034 */ 035 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 036 PortalException.class, SystemException.class}) 037 public interface WorkflowInstanceLinkLocalService extends BaseLocalService, 038 PersistedModelLocalService { 039 /* 040 * NOTE FOR DEVELOPERS: 041 * 042 * 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. 043 */ 044 045 /** 046 * Adds the workflow instance link to the database. Also notifies the appropriate model listeners. 047 * 048 * @param workflowInstanceLink the workflow instance link 049 * @return the workflow instance link that was added 050 * @throws SystemException if a system exception occurred 051 */ 052 public com.liferay.portal.model.WorkflowInstanceLink addWorkflowInstanceLink( 053 com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink) 054 throws com.liferay.portal.kernel.exception.SystemException; 055 056 /** 057 * Creates a new workflow instance link with the primary key. Does not add the workflow instance link to the database. 058 * 059 * @param workflowInstanceLinkId the primary key for the new workflow instance link 060 * @return the new workflow instance link 061 */ 062 public com.liferay.portal.model.WorkflowInstanceLink createWorkflowInstanceLink( 063 long workflowInstanceLinkId); 064 065 /** 066 * Deletes the workflow instance link with the primary key from the database. Also notifies the appropriate model listeners. 067 * 068 * @param workflowInstanceLinkId the primary key of the workflow instance link 069 * @return the workflow instance link that was removed 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 com.liferay.portal.model.WorkflowInstanceLink deleteWorkflowInstanceLink( 074 long workflowInstanceLinkId) 075 throws com.liferay.portal.kernel.exception.PortalException, 076 com.liferay.portal.kernel.exception.SystemException; 077 078 /** 079 * Deletes the workflow instance link from the database. Also notifies the appropriate model listeners. 080 * 081 * @param workflowInstanceLink the workflow instance link 082 * @return the workflow instance link that was removed 083 * @throws PortalException 084 * @throws SystemException if a system exception occurred 085 */ 086 public com.liferay.portal.model.WorkflowInstanceLink deleteWorkflowInstanceLink( 087 com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink) 088 throws com.liferay.portal.kernel.exception.PortalException, 089 com.liferay.portal.kernel.exception.SystemException; 090 091 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 092 093 /** 094 * Performs a dynamic query on the database and returns the matching rows. 095 * 096 * @param dynamicQuery the dynamic query 097 * @return the matching rows 098 * @throws SystemException if a system exception occurred 099 */ 100 @SuppressWarnings("rawtypes") 101 public java.util.List dynamicQuery( 102 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 103 throws com.liferay.portal.kernel.exception.SystemException; 104 105 /** 106 * Performs a dynamic query on the database and returns a range of the matching rows. 107 * 108 * <p> 109 * 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. 110 * </p> 111 * 112 * @param dynamicQuery the dynamic query 113 * @param start the lower bound of the range of model instances 114 * @param end the upper bound of the range of model instances (not inclusive) 115 * @return the range of matching rows 116 * @throws SystemException if a system exception occurred 117 */ 118 @SuppressWarnings("rawtypes") 119 public java.util.List dynamicQuery( 120 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 121 int end) throws com.liferay.portal.kernel.exception.SystemException; 122 123 /** 124 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 125 * 126 * <p> 127 * 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. 128 * </p> 129 * 130 * @param dynamicQuery the dynamic query 131 * @param start the lower bound of the range of model instances 132 * @param end the upper bound of the range of model instances (not inclusive) 133 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 134 * @return the ordered range of matching rows 135 * @throws SystemException if a system exception occurred 136 */ 137 @SuppressWarnings("rawtypes") 138 public java.util.List dynamicQuery( 139 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 140 int end, 141 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 142 throws com.liferay.portal.kernel.exception.SystemException; 143 144 /** 145 * Returns the number of rows that match the dynamic query. 146 * 147 * @param dynamicQuery the dynamic query 148 * @return the number of rows that match the dynamic query 149 * @throws SystemException if a system exception occurred 150 */ 151 public long dynamicQueryCount( 152 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 153 throws com.liferay.portal.kernel.exception.SystemException; 154 155 /** 156 * Returns the number of rows that match the dynamic query. 157 * 158 * @param dynamicQuery the dynamic query 159 * @param projection the projection to apply to the query 160 * @return the number of rows that match the dynamic query 161 * @throws SystemException if a system exception occurred 162 */ 163 public long dynamicQueryCount( 164 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 165 com.liferay.portal.kernel.dao.orm.Projection projection) 166 throws com.liferay.portal.kernel.exception.SystemException; 167 168 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 169 public com.liferay.portal.model.WorkflowInstanceLink fetchWorkflowInstanceLink( 170 long workflowInstanceLinkId) 171 throws com.liferay.portal.kernel.exception.SystemException; 172 173 /** 174 * Returns the workflow instance link with the primary key. 175 * 176 * @param workflowInstanceLinkId the primary key of the workflow instance link 177 * @return the workflow instance link 178 * @throws PortalException if a workflow instance link with the primary key could not be found 179 * @throws SystemException if a system exception occurred 180 */ 181 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 182 public com.liferay.portal.model.WorkflowInstanceLink getWorkflowInstanceLink( 183 long workflowInstanceLinkId) 184 throws com.liferay.portal.kernel.exception.PortalException, 185 com.liferay.portal.kernel.exception.SystemException; 186 187 @Override 188 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 189 public com.liferay.portal.model.PersistedModel getPersistedModel( 190 java.io.Serializable primaryKeyObj) 191 throws com.liferay.portal.kernel.exception.PortalException, 192 com.liferay.portal.kernel.exception.SystemException; 193 194 /** 195 * Returns a range of all the workflow instance links. 196 * 197 * <p> 198 * 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. 199 * </p> 200 * 201 * @param start the lower bound of the range of workflow instance links 202 * @param end the upper bound of the range of workflow instance links (not inclusive) 203 * @return the range of workflow instance links 204 * @throws SystemException if a system exception occurred 205 */ 206 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 207 public java.util.List<com.liferay.portal.model.WorkflowInstanceLink> getWorkflowInstanceLinks( 208 int start, int end) 209 throws com.liferay.portal.kernel.exception.SystemException; 210 211 /** 212 * Returns the number of workflow instance links. 213 * 214 * @return the number of workflow instance links 215 * @throws SystemException if a system exception occurred 216 */ 217 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 218 public int getWorkflowInstanceLinksCount() 219 throws com.liferay.portal.kernel.exception.SystemException; 220 221 /** 222 * Updates the workflow instance link in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 223 * 224 * @param workflowInstanceLink the workflow instance link 225 * @return the workflow instance link that was updated 226 * @throws SystemException if a system exception occurred 227 */ 228 public com.liferay.portal.model.WorkflowInstanceLink updateWorkflowInstanceLink( 229 com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink) 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 com.liferay.portal.model.WorkflowInstanceLink deleteWorkflowInstanceLink( 253 long companyId, long groupId, 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 }