/portal-service/src/com/liferay/portal/service/WorkflowInstanceLinkLocalService.java

https://github.com/monicali/liferay-portal · Java · 298 lines · 118 code · 31 blank · 149 comment · 0 complexity · d04af1a36cac56cf63414c580fa29743 MD5 · raw file

  1. /**
  2. * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
  3. *
  4. * This library is free software; you can redistribute it and/or modify it under
  5. * the terms of the GNU Lesser General Public License as published by the Free
  6. * Software Foundation; either version 2.1 of the License, or (at your option)
  7. * any later version.
  8. *
  9. * This library is distributed in the hope that it will be useful, but WITHOUT
  10. * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  11. * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
  12. * details.
  13. */
  14. package com.liferay.portal.service;
  15. import com.liferay.portal.kernel.exception.PortalException;
  16. import com.liferay.portal.kernel.exception.SystemException;
  17. import com.liferay.portal.kernel.transaction.Isolation;
  18. import com.liferay.portal.kernel.transaction.Propagation;
  19. import com.liferay.portal.kernel.transaction.Transactional;
  20. /**
  21. * The interface for the workflow instance link local service.
  22. *
  23. * <p>
  24. * 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.
  25. * </p>
  26. *
  27. * @author Brian Wing Shun Chan
  28. * @see WorkflowInstanceLinkLocalServiceUtil
  29. * @see com.liferay.portal.service.base.WorkflowInstanceLinkLocalServiceBaseImpl
  30. * @see com.liferay.portal.service.impl.WorkflowInstanceLinkLocalServiceImpl
  31. * @generated
  32. */
  33. @Transactional(isolation = Isolation.PORTAL, rollbackFor = {
  34. PortalException.class, SystemException.class})
  35. public interface WorkflowInstanceLinkLocalService
  36. extends PersistedModelLocalService {
  37. /*
  38. * NOTE FOR DEVELOPERS:
  39. *
  40. * 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.
  41. */
  42. /**
  43. * Adds the workflow instance link to the database. Also notifies the appropriate model listeners.
  44. *
  45. * @param workflowInstanceLink the workflow instance link
  46. * @return the workflow instance link that was added
  47. * @throws SystemException if a system exception occurred
  48. */
  49. public com.liferay.portal.model.WorkflowInstanceLink addWorkflowInstanceLink(
  50. com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink)
  51. throws com.liferay.portal.kernel.exception.SystemException;
  52. /**
  53. * Creates a new workflow instance link with the primary key. Does not add the workflow instance link to the database.
  54. *
  55. * @param workflowInstanceLinkId the primary key for the new workflow instance link
  56. * @return the new workflow instance link
  57. */
  58. public com.liferay.portal.model.WorkflowInstanceLink createWorkflowInstanceLink(
  59. long workflowInstanceLinkId);
  60. /**
  61. * Deletes the workflow instance link with the primary key from the database. Also notifies the appropriate model listeners.
  62. *
  63. * @param workflowInstanceLinkId the primary key of the workflow instance link
  64. * @throws PortalException if a workflow instance link with the primary key could not be found
  65. * @throws SystemException if a system exception occurred
  66. */
  67. public void deleteWorkflowInstanceLink(long workflowInstanceLinkId)
  68. throws com.liferay.portal.kernel.exception.PortalException,
  69. com.liferay.portal.kernel.exception.SystemException;
  70. /**
  71. * Deletes the workflow instance link from the database. Also notifies the appropriate model listeners.
  72. *
  73. * @param workflowInstanceLink the workflow instance link
  74. * @throws SystemException if a system exception occurred
  75. */
  76. public void deleteWorkflowInstanceLink(
  77. com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink)
  78. throws com.liferay.portal.kernel.exception.SystemException;
  79. /**
  80. * Performs a dynamic query on the database and returns the matching rows.
  81. *
  82. * @param dynamicQuery the dynamic query
  83. * @return the matching rows
  84. * @throws SystemException if a system exception occurred
  85. */
  86. @SuppressWarnings("rawtypes")
  87. public java.util.List dynamicQuery(
  88. com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
  89. throws com.liferay.portal.kernel.exception.SystemException;
  90. /**
  91. * Performs a dynamic query on the database and returns a range of the matching rows.
  92. *
  93. * <p>
  94. * 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.
  95. * </p>
  96. *
  97. * @param dynamicQuery the dynamic query
  98. * @param start the lower bound of the range of model instances
  99. * @param end the upper bound of the range of model instances (not inclusive)
  100. * @return the range of matching rows
  101. * @throws SystemException if a system exception occurred
  102. */
  103. @SuppressWarnings("rawtypes")
  104. public java.util.List dynamicQuery(
  105. com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
  106. int end) throws com.liferay.portal.kernel.exception.SystemException;
  107. /**
  108. * Performs a dynamic query on the database and returns an ordered range of the matching rows.
  109. *
  110. * <p>
  111. * 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.
  112. * </p>
  113. *
  114. * @param dynamicQuery the dynamic query
  115. * @param start the lower bound of the range of model instances
  116. * @param end the upper bound of the range of model instances (not inclusive)
  117. * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
  118. * @return the ordered range of matching rows
  119. * @throws SystemException if a system exception occurred
  120. */
  121. @SuppressWarnings("rawtypes")
  122. public java.util.List dynamicQuery(
  123. com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
  124. int end,
  125. com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
  126. throws com.liferay.portal.kernel.exception.SystemException;
  127. /**
  128. * Returns the number of rows that match the dynamic query.
  129. *
  130. * @param dynamicQuery the dynamic query
  131. * @return the number of rows that match the dynamic query
  132. * @throws SystemException if a system exception occurred
  133. */
  134. public long dynamicQueryCount(
  135. com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
  136. throws com.liferay.portal.kernel.exception.SystemException;
  137. @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
  138. public com.liferay.portal.model.WorkflowInstanceLink fetchWorkflowInstanceLink(
  139. long workflowInstanceLinkId)
  140. throws com.liferay.portal.kernel.exception.SystemException;
  141. /**
  142. * Returns the workflow instance link with the primary key.
  143. *
  144. * @param workflowInstanceLinkId the primary key of the workflow instance link
  145. * @return the workflow instance link
  146. * @throws PortalException if a workflow instance link with the primary key could not be found
  147. * @throws SystemException if a system exception occurred
  148. */
  149. @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
  150. public com.liferay.portal.model.WorkflowInstanceLink getWorkflowInstanceLink(
  151. long workflowInstanceLinkId)
  152. throws com.liferay.portal.kernel.exception.PortalException,
  153. com.liferay.portal.kernel.exception.SystemException;
  154. @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
  155. public com.liferay.portal.model.PersistedModel getPersistedModel(
  156. java.io.Serializable primaryKeyObj)
  157. throws com.liferay.portal.kernel.exception.PortalException,
  158. com.liferay.portal.kernel.exception.SystemException;
  159. /**
  160. * Returns a range of all the workflow instance links.
  161. *
  162. * <p>
  163. * 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.
  164. * </p>
  165. *
  166. * @param start the lower bound of the range of workflow instance links
  167. * @param end the upper bound of the range of workflow instance links (not inclusive)
  168. * @return the range of workflow instance links
  169. * @throws SystemException if a system exception occurred
  170. */
  171. @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
  172. public java.util.List<com.liferay.portal.model.WorkflowInstanceLink> getWorkflowInstanceLinks(
  173. int start, int end)
  174. throws com.liferay.portal.kernel.exception.SystemException;
  175. /**
  176. * Returns the number of workflow instance links.
  177. *
  178. * @return the number of workflow instance links
  179. * @throws SystemException if a system exception occurred
  180. */
  181. @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
  182. public int getWorkflowInstanceLinksCount()
  183. throws com.liferay.portal.kernel.exception.SystemException;
  184. /**
  185. * Updates the workflow instance link in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
  186. *
  187. * @param workflowInstanceLink the workflow instance link
  188. * @return the workflow instance link that was updated
  189. * @throws SystemException if a system exception occurred
  190. */
  191. public com.liferay.portal.model.WorkflowInstanceLink updateWorkflowInstanceLink(
  192. com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink)
  193. throws com.liferay.portal.kernel.exception.SystemException;
  194. /**
  195. * Updates the workflow instance link in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
  196. *
  197. * @param workflowInstanceLink the workflow instance link
  198. * @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.
  199. * @return the workflow instance link that was updated
  200. * @throws SystemException if a system exception occurred
  201. */
  202. public com.liferay.portal.model.WorkflowInstanceLink updateWorkflowInstanceLink(
  203. com.liferay.portal.model.WorkflowInstanceLink workflowInstanceLink,
  204. boolean merge)
  205. throws com.liferay.portal.kernel.exception.SystemException;
  206. /**
  207. * Returns the Spring bean ID for this bean.
  208. *
  209. * @return the Spring bean ID for this bean
  210. */
  211. public java.lang.String getBeanIdentifier();
  212. /**
  213. * Sets the Spring bean ID for this bean.
  214. *
  215. * @param beanIdentifier the Spring bean ID for this bean
  216. */
  217. public void setBeanIdentifier(java.lang.String beanIdentifier);
  218. public com.liferay.portal.model.WorkflowInstanceLink addWorkflowInstanceLink(
  219. long userId, long companyId, long groupId, java.lang.String className,
  220. long classPK, long workflowInstanceId)
  221. throws com.liferay.portal.kernel.exception.PortalException,
  222. com.liferay.portal.kernel.exception.SystemException;
  223. public void deleteWorkflowInstanceLink(long companyId, long groupId,
  224. java.lang.String className, long classPK)
  225. throws com.liferay.portal.kernel.exception.PortalException,
  226. com.liferay.portal.kernel.exception.SystemException;
  227. public void deleteWorkflowInstanceLinks(long companyId, long groupId,
  228. java.lang.String className, long classPK)
  229. throws com.liferay.portal.kernel.exception.PortalException,
  230. com.liferay.portal.kernel.exception.SystemException;
  231. @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
  232. public com.liferay.portal.model.WorkflowInstanceLink fetchWorkflowInstanceLink(
  233. long companyId, long groupId, java.lang.String className, long classPK)
  234. throws com.liferay.portal.kernel.exception.SystemException;
  235. @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
  236. public java.lang.String getState(long companyId, long groupId,
  237. java.lang.String className, long classPK)
  238. throws com.liferay.portal.kernel.exception.PortalException,
  239. com.liferay.portal.kernel.exception.SystemException;
  240. @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
  241. public com.liferay.portal.model.WorkflowInstanceLink getWorkflowInstanceLink(
  242. long companyId, long groupId, java.lang.String className, long classPK)
  243. throws com.liferay.portal.kernel.exception.PortalException,
  244. com.liferay.portal.kernel.exception.SystemException;
  245. @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
  246. public java.util.List<com.liferay.portal.model.WorkflowInstanceLink> getWorkflowInstanceLinks(
  247. long companyId, long groupId, java.lang.String className, long classPK)
  248. throws com.liferay.portal.kernel.exception.SystemException;
  249. @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
  250. public boolean hasWorkflowInstanceLink(long companyId, long groupId,
  251. java.lang.String className, long classPK)
  252. throws com.liferay.portal.kernel.exception.SystemException;
  253. @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
  254. public boolean isEnded(long companyId, long groupId,
  255. java.lang.String className, long classPK)
  256. throws com.liferay.portal.kernel.exception.PortalException,
  257. com.liferay.portal.kernel.exception.SystemException;
  258. public void startWorkflowInstance(long companyId, long groupId,
  259. long userId, java.lang.String className, long classPK,
  260. java.util.Map<java.lang.String, java.io.Serializable> workflowContext)
  261. throws com.liferay.portal.kernel.exception.PortalException,
  262. com.liferay.portal.kernel.exception.SystemException;
  263. public void updateClassPK(long companyId, long groupId,
  264. java.lang.String className, long oldClassPK, long newClassPK)
  265. throws com.liferay.portal.kernel.exception.PortalException,
  266. com.liferay.portal.kernel.exception.SystemException;
  267. }