| JournalStructureServiceJSON.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.JSONObject;
26
27 import com.liferay.portlet.journal.service.JournalStructureServiceUtil;
28
29 /**
30 * <a href="JournalStructureServiceJSON.java.html"><b><i>View Source</i></b></a>
31 *
32 * <p>
33 * ServiceBuilder generated this class. Modifications in this class will be
34 * overwritten the next time is generated.
35 * </p>
36 *
37 * <p>
38 * This class provides a JSON utility for the
39 * <code>com.liferay.portlet.journal.service.JournalStructureServiceUtil</code>
40 * service utility. The static methods of this class calls the same methods of
41 * the service utility. However, the signatures are different because it is
42 * difficult for JSON to support certain types.
43 * </p>
44 *
45 * <p>
46 * ServiceBuilder follows certain rules in translating the methods. For example,
47 * if the method in the service utility returns a <code>java.util.List</code>,
48 * that is translated to a
49 * <code>com.liferay.portal.kernel.json.JSONArray</code>. If the method in the
50 * service utility returns a <code>com.liferay.portlet.journal.model.JournalStructure</code>,
51 * that is translated to a
52 * <code>com.liferay.portal.kernel.json.JSONObject</code>. Methods that JSON
53 * cannot safely use are skipped. The logic for the translation is encapsulated
54 * in <code>com.liferay.portlet.journal.service.http.JournalStructureJSONSerializer</code>.
55 * </p>
56 *
57 * <p>
58 * This allows you to call the the backend services directly from JavaScript.
59 * See <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a
60 * reference of how that portlet uses the generated JavaScript in
61 * <code>portal-web/docroot/html/js/service.js</code> to call the backend
62 * services directly from JavaScript.
63 * </p>
64 *
65 * <p>
66 * The JSON utility is only generated for remote services.
67 * </p>
68 *
69 * @author Brian Wing Shun Chan
70 *
71 * @see com.liferay.portlet.journal.service.JournalStructureServiceUtil
72 * @see com.liferay.portlet.journal.service.http.JournalStructureJSONSerializer
73 *
74 */
75 public class JournalStructureServiceJSON {
76 public static JSONObject addStructure(long groupId,
77 java.lang.String structureId, boolean autoStructureId,
78 java.lang.String parentStructureId, java.lang.String name,
79 java.lang.String description, java.lang.String xsd,
80 boolean addCommunityPermissions, boolean addGuestPermissions)
81 throws com.liferay.portal.PortalException,
82 com.liferay.portal.SystemException {
83 com.liferay.portlet.journal.model.JournalStructure returnValue = JournalStructureServiceUtil.addStructure(groupId,
84 structureId, autoStructureId, parentStructureId, name,
85 description, xsd, addCommunityPermissions, addGuestPermissions);
86
87 return JournalStructureJSONSerializer.toJSONObject(returnValue);
88 }
89
90 public static JSONObject addStructure(long groupId,
91 java.lang.String structureId, boolean autoStructureId,
92 java.lang.String parentStructureId, java.lang.String name,
93 java.lang.String description, java.lang.String xsd,
94 java.lang.String[] communityPermissions,
95 java.lang.String[] guestPermissions)
96 throws com.liferay.portal.PortalException,
97 com.liferay.portal.SystemException {
98 com.liferay.portlet.journal.model.JournalStructure returnValue = JournalStructureServiceUtil.addStructure(groupId,
99 structureId, autoStructureId, parentStructureId, name,
100 description, xsd, communityPermissions, guestPermissions);
101
102 return JournalStructureJSONSerializer.toJSONObject(returnValue);
103 }
104
105 public static JSONObject copyStructure(long groupId,
106 java.lang.String oldStructureId, java.lang.String newStructureId,
107 boolean autoStructureId)
108 throws com.liferay.portal.PortalException,
109 com.liferay.portal.SystemException {
110 com.liferay.portlet.journal.model.JournalStructure returnValue = JournalStructureServiceUtil.copyStructure(groupId,
111 oldStructureId, newStructureId, autoStructureId);
112
113 return JournalStructureJSONSerializer.toJSONObject(returnValue);
114 }
115
116 public static void deleteStructure(long groupId,
117 java.lang.String structureId)
118 throws com.liferay.portal.PortalException,
119 com.liferay.portal.SystemException {
120 JournalStructureServiceUtil.deleteStructure(groupId, structureId);
121 }
122
123 public static JSONObject getStructure(long groupId,
124 java.lang.String structureId)
125 throws com.liferay.portal.PortalException,
126 com.liferay.portal.SystemException {
127 com.liferay.portlet.journal.model.JournalStructure returnValue = JournalStructureServiceUtil.getStructure(groupId,
128 structureId);
129
130 return JournalStructureJSONSerializer.toJSONObject(returnValue);
131 }
132
133 public static JSONObject updateStructure(long groupId,
134 java.lang.String structureId, java.lang.String parentStructureId,
135 java.lang.String name, java.lang.String description,
136 java.lang.String xsd)
137 throws com.liferay.portal.PortalException,
138 com.liferay.portal.SystemException {
139 com.liferay.portlet.journal.model.JournalStructure returnValue = JournalStructureServiceUtil.updateStructure(groupId,
140 structureId, parentStructureId, name, description, xsd);
141
142 return JournalStructureJSONSerializer.toJSONObject(returnValue);
143 }
144 }