| JournalTemplateServiceJSON.java |
1 /**
2 * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 * SOFTWARE.
21 */
22
23 package com.liferay.portlet.journal.service.http;
24
25 import com.liferay.portal.kernel.json.JSONArray;
26 import com.liferay.portal.kernel.json.JSONObject;
27
28 import com.liferay.portlet.journal.service.JournalTemplateServiceUtil;
29
30 /**
31 * <a href="JournalTemplateServiceJSON.java.html"><b><i>View Source</i></b></a>
32 *
33 * <p>
34 * ServiceBuilder generated this class. Modifications in this class will be
35 * overwritten the next time is generated.
36 * </p>
37 *
38 * <p>
39 * This class provides a JSON utility for the
40 * <code>com.liferay.portlet.journal.service.JournalTemplateServiceUtil</code>
41 * service utility. The static methods of this class calls the same methods of
42 * the service utility. However, the signatures are different because it is
43 * difficult for JSON to support certain types.
44 * </p>
45 *
46 * <p>
47 * ServiceBuilder follows certain rules in translating the methods. For example,
48 * if the method in the service utility returns a <code>java.util.List</code>,
49 * that is translated to a
50 * <code>com.liferay.portal.kernel.json.JSONArray</code>. If the method in the
51 * service utility returns a <code>com.liferay.portlet.journal.model.JournalTemplate</code>,
52 * that is translated to a
53 * <code>com.liferay.portal.kernel.json.JSONObject</code>. Methods that JSON
54 * cannot safely use are skipped. The logic for the translation is encapsulated
55 * in <code>com.liferay.portlet.journal.service.http.JournalTemplateJSONSerializer</code>.
56 * </p>
57 *
58 * <p>
59 * This allows you to call the the backend services directly from JavaScript.
60 * See <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a
61 * reference of how that portlet uses the generated JavaScript in
62 * <code>portal-web/docroot/html/js/service.js</code> to call the backend
63 * services directly from JavaScript.
64 * </p>
65 *
66 * <p>
67 * The JSON utility is only generated for remote services.
68 * </p>
69 *
70 * @author Brian Wing Shun Chan
71 *
72 * @see com.liferay.portlet.journal.service.JournalTemplateServiceUtil
73 * @see com.liferay.portlet.journal.service.http.JournalTemplateJSONSerializer
74 *
75 */
76 public class JournalTemplateServiceJSON {
77 public static JSONObject copyTemplate(long groupId,
78 java.lang.String oldTemplateId, java.lang.String newTemplateId,
79 boolean autoTemplateId)
80 throws com.liferay.portal.PortalException,
81 com.liferay.portal.SystemException {
82 com.liferay.portlet.journal.model.JournalTemplate returnValue = JournalTemplateServiceUtil.copyTemplate(groupId,
83 oldTemplateId, newTemplateId, autoTemplateId);
84
85 return JournalTemplateJSONSerializer.toJSONObject(returnValue);
86 }
87
88 public static void deleteTemplate(long groupId, java.lang.String templateId)
89 throws com.liferay.portal.PortalException,
90 com.liferay.portal.SystemException {
91 JournalTemplateServiceUtil.deleteTemplate(groupId, templateId);
92 }
93
94 public static JSONArray getStructureTemplates(long groupId,
95 java.lang.String structureId)
96 throws com.liferay.portal.PortalException,
97 com.liferay.portal.SystemException {
98 java.util.List<com.liferay.portlet.journal.model.JournalTemplate> returnValue =
99 JournalTemplateServiceUtil.getStructureTemplates(groupId,
100 structureId);
101
102 return JournalTemplateJSONSerializer.toJSONArray(returnValue);
103 }
104
105 public static JSONObject getTemplate(long groupId,
106 java.lang.String templateId)
107 throws com.liferay.portal.PortalException,
108 com.liferay.portal.SystemException {
109 com.liferay.portlet.journal.model.JournalTemplate returnValue = JournalTemplateServiceUtil.getTemplate(groupId,
110 templateId);
111
112 return JournalTemplateJSONSerializer.toJSONObject(returnValue);
113 }
114 }