/webs/kaleo-web/docroot/WEB-INF/service/com/liferay/portal/workflow/kaleo/service/KaleoDefinitionLocalService.java

https://github.com/stevenjiancao/liferay-plugins · Java · 357 lines · 168 code · 40 blank · 149 comment · 0 complexity · 89abe0ac49eb7f3f761aec057a3c9d87 MD5 · raw file

  1. /**
  2. * Copyright (c) 2000-2011 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.workflow.kaleo.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. import com.liferay.portal.service.PersistedModelLocalService;
  21. /**
  22. * The interface for the kaleo definition local service.
  23. *
  24. * <p>
  25. * 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.
  26. * </p>
  27. *
  28. * @author Brian Wing Shun Chan
  29. * @see KaleoDefinitionLocalServiceUtil
  30. * @see com.liferay.portal.workflow.kaleo.service.base.KaleoDefinitionLocalServiceBaseImpl
  31. * @see com.liferay.portal.workflow.kaleo.service.impl.KaleoDefinitionLocalServiceImpl
  32. * @generated
  33. */
  34. @Transactional(isolation = Isolation.PORTAL, rollbackFor = {
  35. PortalException.class, SystemException.class})
  36. public interface KaleoDefinitionLocalService extends PersistedModelLocalService {
  37. /*
  38. * NOTE FOR DEVELOPERS:
  39. *
  40. * Never modify or reference this interface directly. Always use {@link KaleoDefinitionLocalServiceUtil} to access the kaleo definition local service. Add custom service methods to {@link com.liferay.portal.workflow.kaleo.service.impl.KaleoDefinitionLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
  41. */
  42. /**
  43. * Adds the kaleo definition to the database. Also notifies the appropriate model listeners.
  44. *
  45. * @param kaleoDefinition the kaleo definition
  46. * @return the kaleo definition that was added
  47. * @throws SystemException if a system exception occurred
  48. */
  49. public com.liferay.portal.workflow.kaleo.model.KaleoDefinition addKaleoDefinition(
  50. com.liferay.portal.workflow.kaleo.model.KaleoDefinition kaleoDefinition)
  51. throws com.liferay.portal.kernel.exception.SystemException;
  52. /**
  53. * Creates a new kaleo definition with the primary key. Does not add the kaleo definition to the database.
  54. *
  55. * @param kaleoDefinitionId the primary key for the new kaleo definition
  56. * @return the new kaleo definition
  57. */
  58. public com.liferay.portal.workflow.kaleo.model.KaleoDefinition createKaleoDefinition(
  59. long kaleoDefinitionId);
  60. /**
  61. * Deletes the kaleo definition with the primary key from the database. Also notifies the appropriate model listeners.
  62. *
  63. * @param kaleoDefinitionId the primary key of the kaleo definition
  64. * @throws PortalException if a kaleo definition with the primary key could not be found
  65. * @throws SystemException if a system exception occurred
  66. */
  67. public void deleteKaleoDefinition(long kaleoDefinitionId)
  68. throws com.liferay.portal.kernel.exception.PortalException,
  69. com.liferay.portal.kernel.exception.SystemException;
  70. /**
  71. * Deletes the kaleo definition from the database. Also notifies the appropriate model listeners.
  72. *
  73. * @param kaleoDefinition the kaleo definition
  74. * @throws SystemException if a system exception occurred
  75. */
  76. public void deleteKaleoDefinition(
  77. com.liferay.portal.workflow.kaleo.model.KaleoDefinition kaleoDefinition)
  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. /**
  138. * Returns the kaleo definition with the primary key.
  139. *
  140. * @param kaleoDefinitionId the primary key of the kaleo definition
  141. * @return the kaleo definition
  142. * @throws PortalException if a kaleo definition with the primary key could not be found
  143. * @throws SystemException if a system exception occurred
  144. */
  145. @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
  146. public com.liferay.portal.workflow.kaleo.model.KaleoDefinition getKaleoDefinition(
  147. long kaleoDefinitionId)
  148. throws com.liferay.portal.kernel.exception.PortalException,
  149. com.liferay.portal.kernel.exception.SystemException;
  150. @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
  151. public com.liferay.portal.model.PersistedModel getPersistedModel(
  152. java.io.Serializable primaryKeyObj)
  153. throws com.liferay.portal.kernel.exception.PortalException,
  154. com.liferay.portal.kernel.exception.SystemException;
  155. /**
  156. * Returns a range of all the kaleo definitions.
  157. *
  158. * <p>
  159. * 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.
  160. * </p>
  161. *
  162. * @param start the lower bound of the range of kaleo definitions
  163. * @param end the upper bound of the range of kaleo definitions (not inclusive)
  164. * @return the range of kaleo definitions
  165. * @throws SystemException if a system exception occurred
  166. */
  167. @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
  168. public java.util.List<com.liferay.portal.workflow.kaleo.model.KaleoDefinition> getKaleoDefinitions(
  169. int start, int end)
  170. throws com.liferay.portal.kernel.exception.SystemException;
  171. /**
  172. * Returns the number of kaleo definitions.
  173. *
  174. * @return the number of kaleo definitions
  175. * @throws SystemException if a system exception occurred
  176. */
  177. @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
  178. public int getKaleoDefinitionsCount()
  179. throws com.liferay.portal.kernel.exception.SystemException;
  180. /**
  181. * Updates the kaleo definition in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
  182. *
  183. * @param kaleoDefinition the kaleo definition
  184. * @return the kaleo definition that was updated
  185. * @throws SystemException if a system exception occurred
  186. */
  187. public com.liferay.portal.workflow.kaleo.model.KaleoDefinition updateKaleoDefinition(
  188. com.liferay.portal.workflow.kaleo.model.KaleoDefinition kaleoDefinition)
  189. throws com.liferay.portal.kernel.exception.SystemException;
  190. /**
  191. * Updates the kaleo definition in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
  192. *
  193. * @param kaleoDefinition the kaleo definition
  194. * @param merge whether to merge the kaleo definition 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.
  195. * @return the kaleo definition that was updated
  196. * @throws SystemException if a system exception occurred
  197. */
  198. public com.liferay.portal.workflow.kaleo.model.KaleoDefinition updateKaleoDefinition(
  199. com.liferay.portal.workflow.kaleo.model.KaleoDefinition kaleoDefinition,
  200. boolean merge)
  201. throws com.liferay.portal.kernel.exception.SystemException;
  202. /**
  203. * Returns the Spring bean ID for this bean.
  204. *
  205. * @return the Spring bean ID for this bean
  206. */
  207. public java.lang.String getBeanIdentifier();
  208. /**
  209. * Sets the Spring bean ID for this bean.
  210. *
  211. * @param beanIdentifier the Spring bean ID for this bean
  212. */
  213. public void setBeanIdentifier(java.lang.String beanIdentifier);
  214. public void activateKaleoDefinition(long kaleoDefinitionId,
  215. long startKaleoNodeId,
  216. com.liferay.portal.service.ServiceContext serviceContext)
  217. throws com.liferay.portal.kernel.exception.PortalException,
  218. com.liferay.portal.kernel.exception.SystemException;
  219. public void activateKaleoDefinition(long kaleoDefinitionId,
  220. com.liferay.portal.service.ServiceContext serviceContext)
  221. throws com.liferay.portal.kernel.exception.PortalException,
  222. com.liferay.portal.kernel.exception.SystemException;
  223. public void activateKaleoDefinition(java.lang.String name, int version,
  224. com.liferay.portal.service.ServiceContext serviceContext)
  225. throws com.liferay.portal.kernel.exception.PortalException,
  226. com.liferay.portal.kernel.exception.SystemException;
  227. public com.liferay.portal.workflow.kaleo.model.KaleoDefinition addKaleoDefinition(
  228. java.lang.String name, java.lang.String title,
  229. java.lang.String description, java.lang.String content, int version,
  230. long scope, com.liferay.portal.service.ServiceContext serviceContext)
  231. throws com.liferay.portal.kernel.exception.PortalException,
  232. com.liferay.portal.kernel.exception.SystemException;
  233. public void deactivateKaleoDefinition(java.lang.String name, int version,
  234. com.liferay.portal.service.ServiceContext serviceContext)
  235. throws com.liferay.portal.kernel.exception.PortalException,
  236. com.liferay.portal.kernel.exception.SystemException;
  237. public void deleteCompanyKaleoDefinitions(long companyId)
  238. throws com.liferay.portal.kernel.exception.SystemException;
  239. public void deleteKaleoDefinition(java.lang.String name, int version,
  240. com.liferay.portal.service.ServiceContext serviceContext)
  241. throws com.liferay.portal.kernel.exception.PortalException,
  242. com.liferay.portal.kernel.exception.SystemException;
  243. @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
  244. public com.liferay.portal.workflow.kaleo.model.KaleoDefinition getKaleoDefinition(
  245. java.lang.String name, int version,
  246. com.liferay.portal.service.ServiceContext serviceContext)
  247. throws com.liferay.portal.kernel.exception.PortalException,
  248. com.liferay.portal.kernel.exception.SystemException;
  249. @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
  250. public java.util.List<com.liferay.portal.workflow.kaleo.model.KaleoDefinition> getKaleoDefinitions(
  251. boolean active, int start, int end,
  252. com.liferay.portal.kernel.util.OrderByComparator orderByComparator,
  253. com.liferay.portal.service.ServiceContext serviceContext)
  254. throws com.liferay.portal.kernel.exception.SystemException;
  255. @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
  256. public java.util.List<com.liferay.portal.workflow.kaleo.model.KaleoDefinition> getKaleoDefinitions(
  257. int start, int end,
  258. com.liferay.portal.kernel.util.OrderByComparator orderByComparator,
  259. com.liferay.portal.service.ServiceContext serviceContext)
  260. throws com.liferay.portal.kernel.exception.SystemException;
  261. @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
  262. public java.util.List<com.liferay.portal.workflow.kaleo.model.KaleoDefinition> getKaleoDefinitions(
  263. java.lang.String name, boolean active, int start, int end,
  264. com.liferay.portal.kernel.util.OrderByComparator orderByComparator,
  265. com.liferay.portal.service.ServiceContext serviceContext)
  266. throws com.liferay.portal.kernel.exception.SystemException;
  267. @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
  268. public java.util.List<com.liferay.portal.workflow.kaleo.model.KaleoDefinition> getKaleoDefinitions(
  269. java.lang.String name, int start, int end,
  270. com.liferay.portal.kernel.util.OrderByComparator orderByComparator,
  271. com.liferay.portal.service.ServiceContext serviceContext)
  272. throws com.liferay.portal.kernel.exception.SystemException;
  273. @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
  274. public int getKaleoDefinitionsCount(boolean active,
  275. com.liferay.portal.service.ServiceContext serviceContext)
  276. throws com.liferay.portal.kernel.exception.SystemException;
  277. @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
  278. public int getKaleoDefinitionsCount(
  279. com.liferay.portal.service.ServiceContext serviceContext)
  280. throws com.liferay.portal.kernel.exception.SystemException;
  281. @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
  282. public int getKaleoDefinitionsCount(java.lang.String name, boolean active,
  283. com.liferay.portal.service.ServiceContext serviceContext)
  284. throws com.liferay.portal.kernel.exception.SystemException;
  285. @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
  286. public int getKaleoDefinitionsCount(java.lang.String name,
  287. com.liferay.portal.service.ServiceContext serviceContext)
  288. throws com.liferay.portal.kernel.exception.SystemException;
  289. @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
  290. public com.liferay.portal.workflow.kaleo.model.KaleoDefinition getLatestKaleoDefinition(
  291. java.lang.String name,
  292. com.liferay.portal.service.ServiceContext serviceContext)
  293. throws com.liferay.portal.kernel.exception.PortalException,
  294. com.liferay.portal.kernel.exception.SystemException;
  295. public com.liferay.portal.workflow.kaleo.model.KaleoDefinition incrementKaleoDefinition(
  296. java.lang.String name, java.lang.String title,
  297. com.liferay.portal.service.ServiceContext serviceContext)
  298. throws com.liferay.portal.kernel.exception.PortalException,
  299. com.liferay.portal.kernel.exception.SystemException;
  300. @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
  301. public java.util.List<com.liferay.portal.workflow.kaleo.model.KaleoDefinition> search(
  302. java.lang.String name, java.lang.Boolean active, java.lang.Long scope,
  303. int start, int end,
  304. com.liferay.portal.kernel.util.OrderByComparator orderByComparator,
  305. com.liferay.portal.service.ServiceContext serviceContext)
  306. throws com.liferay.portal.kernel.exception.SystemException;
  307. @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
  308. public int searchCount(java.lang.String name, java.lang.Boolean active,
  309. java.lang.Long scope,
  310. com.liferay.portal.service.ServiceContext serviceContext)
  311. throws com.liferay.portal.kernel.exception.SystemException;
  312. public com.liferay.portal.workflow.kaleo.model.KaleoDefinition updateTitle(
  313. java.lang.String name, int version, java.lang.String title,
  314. com.liferay.portal.service.ServiceContext serviceContext)
  315. throws com.liferay.portal.kernel.exception.PortalException,
  316. com.liferay.portal.kernel.exception.SystemException;
  317. }