1   /**
2    * Copyright (c) 2000-2008 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.softwarecatalog.service.http;
24  
25  import com.liferay.portlet.softwarecatalog.service.SCFrameworkVersionServiceUtil;
26  
27  import org.json.JSONArray;
28  import org.json.JSONObject;
29  
30  /**
31   * <a href="SCFrameworkVersionServiceJSON.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.softwarecatalog.service.SCFrameworkVersionServiceUtil</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 <code>org.json.JSONArray</code>. If the method in the
50   * service utility returns a <code>com.liferay.portlet.softwarecatalog.model.SCFrameworkVersion</code>,
51   * that is translated to a <code>org.json.JSONObject</code>. Methods that JSON
52   * cannot safely use are skipped. The logic for the translation is encapsulated
53   * in <code>com.liferay.portlet.softwarecatalog.service.http.SCFrameworkVersionJSONSerializer</code>.
54   * </p>
55   *
56   * <p>
57   * This allows you to call the the backend services directly from JavaScript.
58   * See <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a
59   * reference of how that portlet uses the generated JavaScript in
60   * <code>portal-web/docroot/html/js/service.js</code> to call the backend
61   * services directly from JavaScript.
62   * </p>
63   *
64   * <p>
65   * The JSON utility is only generated for remote services.
66   * </p>
67   *
68   * @author Brian Wing Shun Chan
69   *
70   * @see com.liferay.portlet.softwarecatalog.service.SCFrameworkVersionServiceUtil
71   * @see com.liferay.portlet.softwarecatalog.service.http.SCFrameworkVersionJSONSerializer
72   *
73   */
74  public class SCFrameworkVersionServiceJSON {
75      public static JSONObject addFrameworkVersion(long plid,
76          java.lang.String name, java.lang.String url, boolean active,
77          int priority, boolean addCommunityPermissions,
78          boolean addGuestPermissions)
79          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
80              com.liferay.portal.PortalException {
81          com.liferay.portlet.softwarecatalog.model.SCFrameworkVersion returnValue =
82              SCFrameworkVersionServiceUtil.addFrameworkVersion(plid, name, url,
83                  active, priority, addCommunityPermissions, addGuestPermissions);
84  
85          return SCFrameworkVersionJSONSerializer.toJSONObject(returnValue);
86      }
87  
88      public static JSONObject addFrameworkVersion(long plid,
89          java.lang.String name, java.lang.String url, boolean active,
90          int priority, java.lang.String[] communityPermissions,
91          java.lang.String[] guestPermissions)
92          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
93              com.liferay.portal.PortalException {
94          com.liferay.portlet.softwarecatalog.model.SCFrameworkVersion returnValue =
95              SCFrameworkVersionServiceUtil.addFrameworkVersion(plid, name, url,
96                  active, priority, communityPermissions, guestPermissions);
97  
98          return SCFrameworkVersionJSONSerializer.toJSONObject(returnValue);
99      }
100 
101     public static void deleteFrameworkVersion(long frameworkVersionId)
102         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
103             com.liferay.portal.PortalException {
104         SCFrameworkVersionServiceUtil.deleteFrameworkVersion(frameworkVersionId);
105     }
106 
107     public static JSONObject getFrameworkVersion(long frameworkVersionId)
108         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
109             com.liferay.portal.PortalException {
110         com.liferay.portlet.softwarecatalog.model.SCFrameworkVersion returnValue =
111             SCFrameworkVersionServiceUtil.getFrameworkVersion(frameworkVersionId);
112 
113         return SCFrameworkVersionJSONSerializer.toJSONObject(returnValue);
114     }
115 
116     public static JSONArray getFrameworkVersions(long groupId, boolean active)
117         throws java.rmi.RemoteException, com.liferay.portal.SystemException {
118         java.util.List<com.liferay.portlet.softwarecatalog.model.SCFrameworkVersion> returnValue =
119             SCFrameworkVersionServiceUtil.getFrameworkVersions(groupId, active);
120 
121         return SCFrameworkVersionJSONSerializer.toJSONArray(returnValue);
122     }
123 
124     public static JSONArray getFrameworkVersions(long groupId, boolean active,
125         int begin, int end)
126         throws java.rmi.RemoteException, com.liferay.portal.SystemException {
127         java.util.List<com.liferay.portlet.softwarecatalog.model.SCFrameworkVersion> returnValue =
128             SCFrameworkVersionServiceUtil.getFrameworkVersions(groupId, active,
129                 begin, end);
130 
131         return SCFrameworkVersionJSONSerializer.toJSONArray(returnValue);
132     }
133 
134     public static JSONObject updateFrameworkVersion(long frameworkVersionId,
135         java.lang.String name, java.lang.String url, boolean active,
136         int priority)
137         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
138             com.liferay.portal.PortalException {
139         com.liferay.portlet.softwarecatalog.model.SCFrameworkVersion returnValue =
140             SCFrameworkVersionServiceUtil.updateFrameworkVersion(frameworkVersionId,
141                 name, url, active, priority);
142 
143         return SCFrameworkVersionJSONSerializer.toJSONObject(returnValue);
144     }
145 }