PageRenderTime 46ms CodeModel.GetById 17ms RepoModel.GetById 0ms app.codeStats 0ms

/modules/dxp/apps/portal-reports-engine-console/portal-reports-engine-console-api/src/main/java/com/liferay/portal/reports/engine/console/service/EntryLocalServiceUtil.java

http://github.com/liferay/liferay-portal
Java | 397 lines | 176 code | 62 blank | 159 comment | 0 complexity | a14e800c91e45def3e720f713cc8a9cd MD5 | raw file
Possible License(s): LGPL-2.0
  1. /**
  2. * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
  3. *
  4. * The contents of this file are subject to the terms of the Liferay Enterprise
  5. * Subscription License ("License"). You may not use this file except in
  6. * compliance with the License. You can obtain a copy of the License by
  7. * contacting Liferay, Inc. See the License for the specific language governing
  8. * permissions and limitations under the License, including but not limited to
  9. * distribution rights of the Software.
  10. *
  11. *
  12. *
  13. */
  14. package com.liferay.portal.reports.engine.console.service;
  15. import com.liferay.petra.sql.dsl.query.DSLQuery;
  16. import com.liferay.portal.kernel.dao.orm.DynamicQuery;
  17. import com.liferay.portal.kernel.exception.PortalException;
  18. import com.liferay.portal.kernel.model.PersistedModel;
  19. import com.liferay.portal.kernel.util.OrderByComparator;
  20. import com.liferay.portal.reports.engine.console.model.Entry;
  21. import java.io.Serializable;
  22. import java.util.List;
  23. /**
  24. * Provides the local service utility for Entry. This utility wraps
  25. * <code>com.liferay.portal.reports.engine.console.service.impl.EntryLocalServiceImpl</code> and
  26. * is an access point for service operations in application layer code running
  27. * on the local server. Methods of this service will not have security checks
  28. * based on the propagated JAAS credentials because this service can only be
  29. * accessed from within the same VM.
  30. *
  31. * @author Brian Wing Shun Chan
  32. * @see EntryLocalService
  33. * @generated
  34. */
  35. public class EntryLocalServiceUtil {
  36. /*
  37. * NOTE FOR DEVELOPERS:
  38. *
  39. * Never modify this class directly. Add custom service methods to <code>com.liferay.portal.reports.engine.console.service.impl.EntryLocalServiceImpl</code> and rerun ServiceBuilder to regenerate this class.
  40. */
  41. /**
  42. * Adds the entry to the database. Also notifies the appropriate model listeners.
  43. *
  44. * <p>
  45. * <strong>Important:</strong> Inspect EntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
  46. * </p>
  47. *
  48. * @param entry the entry
  49. * @return the entry that was added
  50. */
  51. public static Entry addEntry(Entry entry) {
  52. return getService().addEntry(entry);
  53. }
  54. public static Entry addEntry(
  55. long userId, long groupId, long definitionId, String format,
  56. boolean schedulerRequest, java.util.Date startDate,
  57. java.util.Date endDate, boolean repeating, String recurrence,
  58. String emailNotifications, String emailDelivery, String portletId,
  59. String pageURL, String reportName, String reportParameters,
  60. com.liferay.portal.kernel.service.ServiceContext serviceContext)
  61. throws PortalException {
  62. return getService().addEntry(
  63. userId, groupId, definitionId, format, schedulerRequest, startDate,
  64. endDate, repeating, recurrence, emailNotifications, emailDelivery,
  65. portletId, pageURL, reportName, reportParameters, serviceContext);
  66. }
  67. public static void addEntryResources(
  68. Entry entry, boolean addCommunityPermissions,
  69. boolean addGuestPermissions)
  70. throws PortalException {
  71. getService().addEntryResources(
  72. entry, addCommunityPermissions, addGuestPermissions);
  73. }
  74. public static void addEntryResources(
  75. Entry entry, String[] communityPermissions,
  76. String[] guestPermissions)
  77. throws PortalException {
  78. getService().addEntryResources(
  79. entry, communityPermissions, guestPermissions);
  80. }
  81. /**
  82. * Creates a new entry with the primary key. Does not add the entry to the database.
  83. *
  84. * @param entryId the primary key for the new entry
  85. * @return the new entry
  86. */
  87. public static Entry createEntry(long entryId) {
  88. return getService().createEntry(entryId);
  89. }
  90. /**
  91. * @throws PortalException
  92. */
  93. public static PersistedModel createPersistedModel(
  94. Serializable primaryKeyObj)
  95. throws PortalException {
  96. return getService().createPersistedModel(primaryKeyObj);
  97. }
  98. public static void deleteAttachment(long companyId, String fileName)
  99. throws PortalException {
  100. getService().deleteAttachment(companyId, fileName);
  101. }
  102. /**
  103. * Deletes the entry from the database. Also notifies the appropriate model listeners.
  104. *
  105. * <p>
  106. * <strong>Important:</strong> Inspect EntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
  107. * </p>
  108. *
  109. * @param entry the entry
  110. * @return the entry that was removed
  111. * @throws PortalException
  112. */
  113. public static Entry deleteEntry(Entry entry) throws PortalException {
  114. return getService().deleteEntry(entry);
  115. }
  116. /**
  117. * Deletes the entry with the primary key from the database. Also notifies the appropriate model listeners.
  118. *
  119. * <p>
  120. * <strong>Important:</strong> Inspect EntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
  121. * </p>
  122. *
  123. * @param entryId the primary key of the entry
  124. * @return the entry that was removed
  125. * @throws PortalException if a entry with the primary key could not be found
  126. */
  127. public static Entry deleteEntry(long entryId) throws PortalException {
  128. return getService().deleteEntry(entryId);
  129. }
  130. /**
  131. * @throws PortalException
  132. */
  133. public static PersistedModel deletePersistedModel(
  134. PersistedModel persistedModel)
  135. throws PortalException {
  136. return getService().deletePersistedModel(persistedModel);
  137. }
  138. public static <T> T dslQuery(DSLQuery dslQuery) {
  139. return getService().dslQuery(dslQuery);
  140. }
  141. public static int dslQueryCount(DSLQuery dslQuery) {
  142. return getService().dslQueryCount(dslQuery);
  143. }
  144. public static DynamicQuery dynamicQuery() {
  145. return getService().dynamicQuery();
  146. }
  147. /**
  148. * Performs a dynamic query on the database and returns the matching rows.
  149. *
  150. * @param dynamicQuery the dynamic query
  151. * @return the matching rows
  152. */
  153. public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery) {
  154. return getService().dynamicQuery(dynamicQuery);
  155. }
  156. /**
  157. * Performs a dynamic query on the database and returns a range of the matching rows.
  158. *
  159. * <p>
  160. * 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 <code>com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS</code> 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, then the query will include the default ORDER BY logic from <code>com.liferay.portal.reports.engine.console.model.impl.EntryModelImpl</code>.
  161. * </p>
  162. *
  163. * @param dynamicQuery the dynamic query
  164. * @param start the lower bound of the range of model instances
  165. * @param end the upper bound of the range of model instances (not inclusive)
  166. * @return the range of matching rows
  167. */
  168. public static <T> List<T> dynamicQuery(
  169. DynamicQuery dynamicQuery, int start, int end) {
  170. return getService().dynamicQuery(dynamicQuery, start, end);
  171. }
  172. /**
  173. * Performs a dynamic query on the database and returns an ordered range of the matching rows.
  174. *
  175. * <p>
  176. * 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 <code>com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS</code> 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, then the query will include the default ORDER BY logic from <code>com.liferay.portal.reports.engine.console.model.impl.EntryModelImpl</code>.
  177. * </p>
  178. *
  179. * @param dynamicQuery the dynamic query
  180. * @param start the lower bound of the range of model instances
  181. * @param end the upper bound of the range of model instances (not inclusive)
  182. * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
  183. * @return the ordered range of matching rows
  184. */
  185. public static <T> List<T> dynamicQuery(
  186. DynamicQuery dynamicQuery, int start, int end,
  187. OrderByComparator<T> orderByComparator) {
  188. return getService().dynamicQuery(
  189. dynamicQuery, start, end, orderByComparator);
  190. }
  191. /**
  192. * Returns the number of rows matching the dynamic query.
  193. *
  194. * @param dynamicQuery the dynamic query
  195. * @return the number of rows matching the dynamic query
  196. */
  197. public static long dynamicQueryCount(DynamicQuery dynamicQuery) {
  198. return getService().dynamicQueryCount(dynamicQuery);
  199. }
  200. /**
  201. * Returns the number of rows matching the dynamic query.
  202. *
  203. * @param dynamicQuery the dynamic query
  204. * @param projection the projection to apply to the query
  205. * @return the number of rows matching the dynamic query
  206. */
  207. public static long dynamicQueryCount(
  208. DynamicQuery dynamicQuery,
  209. com.liferay.portal.kernel.dao.orm.Projection projection) {
  210. return getService().dynamicQueryCount(dynamicQuery, projection);
  211. }
  212. public static Entry fetchEntry(long entryId) {
  213. return getService().fetchEntry(entryId);
  214. }
  215. public static void generateReport(long entryId) throws PortalException {
  216. getService().generateReport(entryId);
  217. }
  218. public static void generateReport(long entryId, String reportName)
  219. throws PortalException {
  220. getService().generateReport(entryId, reportName);
  221. }
  222. public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
  223. getActionableDynamicQuery() {
  224. return getService().getActionableDynamicQuery();
  225. }
  226. /**
  227. * Returns a range of all the entries.
  228. *
  229. * <p>
  230. * 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 <code>com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS</code> 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, then the query will include the default ORDER BY logic from <code>com.liferay.portal.reports.engine.console.model.impl.EntryModelImpl</code>.
  231. * </p>
  232. *
  233. * @param start the lower bound of the range of entries
  234. * @param end the upper bound of the range of entries (not inclusive)
  235. * @return the range of entries
  236. */
  237. public static List<Entry> getEntries(int start, int end) {
  238. return getService().getEntries(start, end);
  239. }
  240. public static List<Entry> getEntries(
  241. long groupId, String definitionName, String userName,
  242. java.util.Date createDateGT, java.util.Date createDateLT,
  243. boolean andSearch, int start, int end,
  244. OrderByComparator<Entry> orderByComparator) {
  245. return getService().getEntries(
  246. groupId, definitionName, userName, createDateGT, createDateLT,
  247. andSearch, start, end, orderByComparator);
  248. }
  249. /**
  250. * Returns the number of entries.
  251. *
  252. * @return the number of entries
  253. */
  254. public static int getEntriesCount() {
  255. return getService().getEntriesCount();
  256. }
  257. public static int getEntriesCount(
  258. long groupId, String definitionName, String userName,
  259. java.util.Date createDateGT, java.util.Date createDateLT,
  260. boolean andSearch) {
  261. return getService().getEntriesCount(
  262. groupId, definitionName, userName, createDateGT, createDateLT,
  263. andSearch);
  264. }
  265. /**
  266. * Returns the entry with the primary key.
  267. *
  268. * @param entryId the primary key of the entry
  269. * @return the entry
  270. * @throws PortalException if a entry with the primary key could not be found
  271. */
  272. public static Entry getEntry(long entryId) throws PortalException {
  273. return getService().getEntry(entryId);
  274. }
  275. public static
  276. com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
  277. getIndexableActionableDynamicQuery() {
  278. return getService().getIndexableActionableDynamicQuery();
  279. }
  280. /**
  281. * Returns the OSGi service identifier.
  282. *
  283. * @return the OSGi service identifier
  284. */
  285. public static String getOSGiServiceIdentifier() {
  286. return getService().getOSGiServiceIdentifier();
  287. }
  288. /**
  289. * @throws PortalException
  290. */
  291. public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
  292. throws PortalException {
  293. return getService().getPersistedModel(primaryKeyObj);
  294. }
  295. public static void sendEmails(
  296. long entryId, String fileName, String[] emailAddresses,
  297. boolean notification)
  298. throws PortalException {
  299. getService().sendEmails(
  300. entryId, fileName, emailAddresses, notification);
  301. }
  302. public static void unscheduleEntry(long entryId) throws PortalException {
  303. getService().unscheduleEntry(entryId);
  304. }
  305. /**
  306. * Updates the entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
  307. *
  308. * <p>
  309. * <strong>Important:</strong> Inspect EntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
  310. * </p>
  311. *
  312. * @param entry the entry
  313. * @return the entry that was updated
  314. */
  315. public static Entry updateEntry(Entry entry) {
  316. return getService().updateEntry(entry);
  317. }
  318. public static void updateEntry(
  319. long entryId, String reportName, byte[] reportResults)
  320. throws PortalException {
  321. getService().updateEntry(entryId, reportName, reportResults);
  322. }
  323. public static void updateEntryStatus(
  324. long entryId,
  325. com.liferay.portal.reports.engine.console.status.ReportStatus
  326. status,
  327. String errorMessage)
  328. throws PortalException {
  329. getService().updateEntryStatus(entryId, status, errorMessage);
  330. }
  331. public static EntryLocalService getService() {
  332. return _service;
  333. }
  334. private static volatile EntryLocalService _service;
  335. }