com.liferay.portlet.journal.service.http
Class JournalArticleServiceJSON

java.lang.Object
  extended by com.liferay.portlet.journal.service.http.JournalArticleServiceJSON

public class JournalArticleServiceJSON
extends java.lang.Object

View Source

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

This class provides a JSON utility for the com.liferay.portlet.journal.service.JournalArticleServiceUtil service utility. The static methods of this class calls the same methods of the service utility. However, the signatures are different because it is difficult for JSON to support certain types.

ServiceBuilder follows certain rules in translating the methods. For example, if the method in the service utility returns a java.util.List, that is translated to a com.liferay.portal.kernel.json.JSONArray. If the method in the service utility returns a com.liferay.portlet.journal.model.JournalArticle, that is translated to a com.liferay.portal.kernel.json.JSONObject. Methods that JSON cannot safely use are skipped. The logic for the translation is encapsulated in com.liferay.portlet.journal.service.http.JournalArticleJSONSerializer.

This allows you to call the the backend services directly from JavaScript. See portal-web/docroot/html/portlet/tags_admin/unpacked.js for a reference of how that portlet uses the generated JavaScript in portal-web/docroot/html/js/service.js to call the backend services directly from JavaScript.

The JSON utility is only generated for remote services.

Author:
Brian Wing Shun Chan
See Also:
JournalArticleServiceUtil, JournalArticleJSONSerializer

Constructor Summary
JournalArticleServiceJSON()
           
 
Method Summary
static com.liferay.portal.kernel.json.JSONObject addArticle(long groupId, java.lang.String articleId, boolean autoArticleId, java.lang.String title, java.lang.String description, java.lang.String content, java.lang.String type, java.lang.String structureId, java.lang.String templateId, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, int reviewDateMonth, int reviewDateDay, int reviewDateYear, int reviewDateHour, int reviewDateMinute, boolean neverReview, boolean indexable, java.lang.String articleURL, java.lang.String[] tagsCategories, java.lang.String[] tagsEntries, boolean addCommunityPermissions, boolean addGuestPermissions)
           
static com.liferay.portal.kernel.json.JSONObject addArticle(long groupId, java.lang.String articleId, boolean autoArticleId, java.lang.String title, java.lang.String description, java.lang.String content, java.lang.String type, java.lang.String structureId, java.lang.String templateId, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, int reviewDateMonth, int reviewDateDay, int reviewDateYear, int reviewDateHour, int reviewDateMinute, boolean neverReview, boolean indexable, java.lang.String articleURL, java.lang.String[] tagsCategories, java.lang.String[] tagsEntries, java.lang.String[] communityPermissions, java.lang.String[] guestPermissions)
           
static com.liferay.portal.kernel.json.JSONObject copyArticle(long groupId, java.lang.String oldArticleId, java.lang.String newArticleId, boolean autoArticleId, double version)
           
static com.liferay.portal.kernel.json.JSONObject getArticle(long groupId, java.lang.String articleId, double version)
           
static void removeArticleLocale(long companyId, java.lang.String languageId)
           
static com.liferay.portal.kernel.json.JSONObject removeArticleLocale(long groupId, java.lang.String articleId, double version, java.lang.String languageId)
           
static com.liferay.portal.kernel.json.JSONObject updateContent(long groupId, java.lang.String articleId, double version, java.lang.String content)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JournalArticleServiceJSON

public JournalArticleServiceJSON()
Method Detail

addArticle

public static com.liferay.portal.kernel.json.JSONObject addArticle(long groupId,
                                                                   java.lang.String articleId,
                                                                   boolean autoArticleId,
                                                                   java.lang.String title,
                                                                   java.lang.String description,
                                                                   java.lang.String content,
                                                                   java.lang.String type,
                                                                   java.lang.String structureId,
                                                                   java.lang.String templateId,
                                                                   int displayDateMonth,
                                                                   int displayDateDay,
                                                                   int displayDateYear,
                                                                   int displayDateHour,
                                                                   int displayDateMinute,
                                                                   int expirationDateMonth,
                                                                   int expirationDateDay,
                                                                   int expirationDateYear,
                                                                   int expirationDateHour,
                                                                   int expirationDateMinute,
                                                                   boolean neverExpire,
                                                                   int reviewDateMonth,
                                                                   int reviewDateDay,
                                                                   int reviewDateYear,
                                                                   int reviewDateHour,
                                                                   int reviewDateMinute,
                                                                   boolean neverReview,
                                                                   boolean indexable,
                                                                   java.lang.String articleURL,
                                                                   java.lang.String[] tagsCategories,
                                                                   java.lang.String[] tagsEntries,
                                                                   boolean addCommunityPermissions,
                                                                   boolean addGuestPermissions)
                                                            throws com.liferay.portal.PortalException,
                                                                   com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

addArticle

public static com.liferay.portal.kernel.json.JSONObject addArticle(long groupId,
                                                                   java.lang.String articleId,
                                                                   boolean autoArticleId,
                                                                   java.lang.String title,
                                                                   java.lang.String description,
                                                                   java.lang.String content,
                                                                   java.lang.String type,
                                                                   java.lang.String structureId,
                                                                   java.lang.String templateId,
                                                                   int displayDateMonth,
                                                                   int displayDateDay,
                                                                   int displayDateYear,
                                                                   int displayDateHour,
                                                                   int displayDateMinute,
                                                                   int expirationDateMonth,
                                                                   int expirationDateDay,
                                                                   int expirationDateYear,
                                                                   int expirationDateHour,
                                                                   int expirationDateMinute,
                                                                   boolean neverExpire,
                                                                   int reviewDateMonth,
                                                                   int reviewDateDay,
                                                                   int reviewDateYear,
                                                                   int reviewDateHour,
                                                                   int reviewDateMinute,
                                                                   boolean neverReview,
                                                                   boolean indexable,
                                                                   java.lang.String articleURL,
                                                                   java.lang.String[] tagsCategories,
                                                                   java.lang.String[] tagsEntries,
                                                                   java.lang.String[] communityPermissions,
                                                                   java.lang.String[] guestPermissions)
                                                            throws com.liferay.portal.PortalException,
                                                                   com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

copyArticle

public static com.liferay.portal.kernel.json.JSONObject copyArticle(long groupId,
                                                                    java.lang.String oldArticleId,
                                                                    java.lang.String newArticleId,
                                                                    boolean autoArticleId,
                                                                    double version)
                                                             throws com.liferay.portal.PortalException,
                                                                    com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getArticle

public static com.liferay.portal.kernel.json.JSONObject getArticle(long groupId,
                                                                   java.lang.String articleId,
                                                                   double version)
                                                            throws com.liferay.portal.PortalException,
                                                                   com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

removeArticleLocale

public static void removeArticleLocale(long companyId,
                                       java.lang.String languageId)
                                throws com.liferay.portal.PortalException,
                                       com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

removeArticleLocale

public static com.liferay.portal.kernel.json.JSONObject removeArticleLocale(long groupId,
                                                                            java.lang.String articleId,
                                                                            double version,
                                                                            java.lang.String languageId)
                                                                     throws com.liferay.portal.PortalException,
                                                                            com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateContent

public static com.liferay.portal.kernel.json.JSONObject updateContent(long groupId,
                                                                      java.lang.String articleId,
                                                                      double version,
                                                                      java.lang.String content)
                                                               throws com.liferay.portal.PortalException,
                                                                      com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException