com.liferay.portlet.tags.service.http
Class TagsAssetServiceJSON

java.lang.Object
  extended by com.liferay.portlet.tags.service.http.TagsAssetServiceJSON

public class TagsAssetServiceJSON
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.tags.service.TagsAssetServiceUtil 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.tags.model.TagsAsset, 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.tags.service.http.TagsAssetJSONSerializer.

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:
TagsAssetServiceUtil, TagsAssetJSONSerializer

Constructor Summary
TagsAssetServiceJSON()
           
 
Method Summary
static void deleteAsset(long assetId)
           
static com.liferay.portal.kernel.json.JSONObject getAsset(long assetId)
           
static com.liferay.portal.kernel.json.JSONArray getAssets(long groupId, long[] classNameIds, long[] entryIds, long[] notEntryIds, boolean andOperator, java.lang.String orderByCol1, java.lang.String orderByCol2, java.lang.String orderByType1, java.lang.String orderByType2, boolean excludeZeroViewCount, java.util.Date publishDate, java.util.Date expirationDate, int start, int end)
           
static int getAssetsCount(long groupId, long[] classNameIds, long[] entryIds, long[] notEntryIds, boolean andOperator, boolean excludeZeroViewCount, java.util.Date publishDate, java.util.Date expirationDate)
           
static java.lang.String getAssetsRSS(long groupId, long[] classNameIds, long[] entryIds, long[] notEntryIds, boolean andOperator, java.lang.String orderByCol1, java.lang.String orderByCol2, java.lang.String orderByType1, java.lang.String orderByType2, boolean excludeZeroViewCount, java.util.Date publishDate, java.util.Date expirationDate, int max, java.lang.String type, double version, java.lang.String displayStyle, java.lang.String feedURL, java.lang.String entryURL)
           
static com.liferay.portlet.tags.model.TagsAssetType[] getAssetTypes(java.lang.String languageId)
           
static com.liferay.portlet.tags.model.TagsAssetDisplay[] getCompanyAssetDisplays(long companyId, int start, int end, java.lang.String languageId)
           
static com.liferay.portal.kernel.json.JSONArray getCompanyAssets(long companyId, int start, int end)
           
static int getCompanyAssetsCount(long companyId)
           
static java.lang.String getCompanyAssetsRSS(long companyId, int max, java.lang.String type, double version, java.lang.String displayStyle, java.lang.String feedURL, java.lang.String entryURL)
           
static com.liferay.portal.kernel.json.JSONObject incrementViewCounter(java.lang.String className, long classPK)
           
static com.liferay.portlet.tags.model.TagsAssetDisplay[] searchAssetDisplays(long companyId, java.lang.String portletId, java.lang.String keywords, java.lang.String languageId, int start, int end)
           
static int searchAssetDisplaysCount(long companyId, java.lang.String portletId, java.lang.String keywords, java.lang.String languageId)
           
static com.liferay.portal.kernel.json.JSONObject updateAsset(long groupId, java.lang.String className, long classPK, java.lang.String[] categoryNames, java.lang.String[] entryNames, boolean visible, java.util.Date startDate, java.util.Date endDate, java.util.Date publishDate, java.util.Date expirationDate, java.lang.String mimeType, java.lang.String title, java.lang.String description, java.lang.String summary, java.lang.String url, int height, int width, java.lang.Integer priority)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TagsAssetServiceJSON

public TagsAssetServiceJSON()
Method Detail

deleteAsset

public static void deleteAsset(long assetId)
                        throws com.liferay.portal.PortalException,
                               com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getAsset

public static com.liferay.portal.kernel.json.JSONObject getAsset(long assetId)
                                                          throws com.liferay.portal.PortalException,
                                                                 com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getAssets

public static com.liferay.portal.kernel.json.JSONArray getAssets(long groupId,
                                                                 long[] classNameIds,
                                                                 long[] entryIds,
                                                                 long[] notEntryIds,
                                                                 boolean andOperator,
                                                                 java.lang.String orderByCol1,
                                                                 java.lang.String orderByCol2,
                                                                 java.lang.String orderByType1,
                                                                 java.lang.String orderByType2,
                                                                 boolean excludeZeroViewCount,
                                                                 java.util.Date publishDate,
                                                                 java.util.Date expirationDate,
                                                                 int start,
                                                                 int end)
                                                          throws com.liferay.portal.PortalException,
                                                                 com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getAssetsCount

public static int getAssetsCount(long groupId,
                                 long[] classNameIds,
                                 long[] entryIds,
                                 long[] notEntryIds,
                                 boolean andOperator,
                                 boolean excludeZeroViewCount,
                                 java.util.Date publishDate,
                                 java.util.Date expirationDate)
                          throws com.liferay.portal.PortalException,
                                 com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getAssetsRSS

public static java.lang.String getAssetsRSS(long groupId,
                                            long[] classNameIds,
                                            long[] entryIds,
                                            long[] notEntryIds,
                                            boolean andOperator,
                                            java.lang.String orderByCol1,
                                            java.lang.String orderByCol2,
                                            java.lang.String orderByType1,
                                            java.lang.String orderByType2,
                                            boolean excludeZeroViewCount,
                                            java.util.Date publishDate,
                                            java.util.Date expirationDate,
                                            int max,
                                            java.lang.String type,
                                            double version,
                                            java.lang.String displayStyle,
                                            java.lang.String feedURL,
                                            java.lang.String entryURL)
                                     throws com.liferay.portal.PortalException,
                                            com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getAssetTypes

public static com.liferay.portlet.tags.model.TagsAssetType[] getAssetTypes(java.lang.String languageId)

getCompanyAssetDisplays

public static com.liferay.portlet.tags.model.TagsAssetDisplay[] getCompanyAssetDisplays(long companyId,
                                                                                        int start,
                                                                                        int end,
                                                                                        java.lang.String languageId)
                                                                                 throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

getCompanyAssets

public static com.liferay.portal.kernel.json.JSONArray getCompanyAssets(long companyId,
                                                                        int start,
                                                                        int end)
                                                                 throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

getCompanyAssetsCount

public static int getCompanyAssetsCount(long companyId)
                                 throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

getCompanyAssetsRSS

public static java.lang.String getCompanyAssetsRSS(long companyId,
                                                   int max,
                                                   java.lang.String type,
                                                   double version,
                                                   java.lang.String displayStyle,
                                                   java.lang.String feedURL,
                                                   java.lang.String entryURL)
                                            throws com.liferay.portal.PortalException,
                                                   com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

incrementViewCounter

public static com.liferay.portal.kernel.json.JSONObject incrementViewCounter(java.lang.String className,
                                                                             long classPK)
                                                                      throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

searchAssetDisplays

public static com.liferay.portlet.tags.model.TagsAssetDisplay[] searchAssetDisplays(long companyId,
                                                                                    java.lang.String portletId,
                                                                                    java.lang.String keywords,
                                                                                    java.lang.String languageId,
                                                                                    int start,
                                                                                    int end)
                                                                             throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

searchAssetDisplaysCount

public static int searchAssetDisplaysCount(long companyId,
                                           java.lang.String portletId,
                                           java.lang.String keywords,
                                           java.lang.String languageId)
                                    throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

updateAsset

public static com.liferay.portal.kernel.json.JSONObject updateAsset(long groupId,
                                                                    java.lang.String className,
                                                                    long classPK,
                                                                    java.lang.String[] categoryNames,
                                                                    java.lang.String[] entryNames,
                                                                    boolean visible,
                                                                    java.util.Date startDate,
                                                                    java.util.Date endDate,
                                                                    java.util.Date publishDate,
                                                                    java.util.Date expirationDate,
                                                                    java.lang.String mimeType,
                                                                    java.lang.String title,
                                                                    java.lang.String description,
                                                                    java.lang.String summary,
                                                                    java.lang.String url,
                                                                    int height,
                                                                    int width,
                                                                    java.lang.Integer priority)
                                                             throws com.liferay.portal.PortalException,
                                                                    com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException