1   /**
2    * Copyright (c) 2000-2009 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   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
12   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
13   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
14   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
15   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
16   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
17   * SOFTWARE.
18   */
19  
20  package com.liferay.portlet.journal.service.http;
21  
22  import com.liferay.portal.kernel.json.JSONObject;
23  
24  import com.liferay.portlet.journal.service.JournalStructureServiceUtil;
25  
26  /**
27   * <a href="JournalStructureServiceJSON.java.html"><b><i>View Source</i></b></a>
28   *
29   * <p>
30   * ServiceBuilder generated this class. Modifications in this class will be
31   * overwritten the next time is generated.
32   * </p>
33   *
34   * <p>
35   * This class provides a JSON utility for the
36   * <code>com.liferay.portlet.journal.service.JournalStructureServiceUtil</code>
37   * service utility. The static methods of this class calls the same methods of
38   * the service utility. However, the signatures are different because it is
39   * difficult for JSON to support certain types.
40   * </p>
41   *
42   * <p>
43   * ServiceBuilder follows certain rules in translating the methods. For example,
44   * if the method in the service utility returns a <code>java.util.List</code>,
45   * that is translated to a
46   * <code>com.liferay.portal.kernel.json.JSONArray</code>. If the method in the
47   * service utility returns a <code>com.liferay.portlet.journal.model.JournalStructure</code>,
48   * that is translated to a
49   * <code>com.liferay.portal.kernel.json.JSONObject</code>. Methods that JSON
50   * cannot safely use are skipped. The logic for the translation is encapsulated
51   * in <code>com.liferay.portlet.journal.service.http.JournalStructureJSONSerializer</code>.
52   * </p>
53   *
54   * <p>
55   * This allows you to call the the backend services directly from JavaScript.
56   * See <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a
57   * reference of how that portlet uses the generated JavaScript in
58   * <code>portal-web/docroot/html/js/service.js</code> to call the backend
59   * services directly from JavaScript.
60   * </p>
61   *
62   * <p>
63   * The JSON utility is only generated for remote services.
64   * </p>
65   *
66   * @author Brian Wing Shun Chan
67   *
68   * @see com.liferay.portlet.journal.service.JournalStructureServiceUtil
69   * @see com.liferay.portlet.journal.service.http.JournalStructureJSONSerializer
70   *
71   */
72  public class JournalStructureServiceJSON {
73      public static JSONObject addStructure(java.lang.String structureId,
74          boolean autoStructureId, long plid, java.lang.String name,
75          java.lang.String description, java.lang.String xsd,
76          boolean addCommunityPermissions, boolean addGuestPermissions)
77          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
78              com.liferay.portal.SystemException {
79          com.liferay.portlet.journal.model.JournalStructure returnValue = JournalStructureServiceUtil.addStructure(structureId,
80                  autoStructureId, plid, name, description, xsd,
81                  addCommunityPermissions, addGuestPermissions);
82  
83          return JournalStructureJSONSerializer.toJSONObject(returnValue);
84      }
85  
86      public static JSONObject addStructure(java.lang.String structureId,
87          boolean autoStructureId, long plid, java.lang.String name,
88          java.lang.String description, java.lang.String xsd,
89          java.lang.String[] communityPermissions,
90          java.lang.String[] guestPermissions)
91          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
92              com.liferay.portal.SystemException {
93          com.liferay.portlet.journal.model.JournalStructure returnValue = JournalStructureServiceUtil.addStructure(structureId,
94                  autoStructureId, plid, name, description, xsd,
95                  communityPermissions, guestPermissions);
96  
97          return JournalStructureJSONSerializer.toJSONObject(returnValue);
98      }
99  
100     public static JSONObject copyStructure(long groupId,
101         java.lang.String oldStructureId, java.lang.String newStructureId,
102         boolean autoStructureId)
103         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
104             com.liferay.portal.SystemException {
105         com.liferay.portlet.journal.model.JournalStructure returnValue = JournalStructureServiceUtil.copyStructure(groupId,
106                 oldStructureId, newStructureId, autoStructureId);
107 
108         return JournalStructureJSONSerializer.toJSONObject(returnValue);
109     }
110 
111     public static void deleteStructure(long groupId,
112         java.lang.String structureId)
113         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
114             com.liferay.portal.SystemException {
115         JournalStructureServiceUtil.deleteStructure(groupId, structureId);
116     }
117 
118     public static JSONObject getStructure(long groupId,
119         java.lang.String structureId)
120         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
121             com.liferay.portal.SystemException {
122         com.liferay.portlet.journal.model.JournalStructure returnValue = JournalStructureServiceUtil.getStructure(groupId,
123                 structureId);
124 
125         return JournalStructureJSONSerializer.toJSONObject(returnValue);
126     }
127 
128     public static JSONObject updateStructure(long groupId,
129         java.lang.String structureId, java.lang.String name,
130         java.lang.String description, java.lang.String xsd)
131         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
132             com.liferay.portal.SystemException {
133         com.liferay.portlet.journal.model.JournalStructure returnValue = JournalStructureServiceUtil.updateStructure(groupId,
134                 structureId, name, description, xsd);
135 
136         return JournalStructureJSONSerializer.toJSONObject(returnValue);
137     }
138 }