com.liferay.portlet.asset.service.http

Class AssetCategoryServiceSoap

java.lang.Object

com.liferay.portlet.asset.service.http.AssetCategoryServiceSoap

public class AssetCategoryServiceSoap
extends java.lang.Object

Provides the SOAP utility for the AssetCategoryServiceUtil service utility. The static methods of this class call the same methods of the service utility. However, the signatures are different because it is difficult for SOAP 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 an array of com.liferay.asset.kernel.model.AssetCategorySoap. If the method in the service utility returns a com.liferay.asset.kernel.model.AssetCategory, that is translated to a com.liferay.asset.kernel.model.AssetCategorySoap. Methods that SOAP cannot safely wire are skipped.

The benefits of using the SOAP utility is that it is cross platform compatible. SOAP allows different languages like Java, .NET, C++, PHP, and even Perl, to call the generated services. One drawback of SOAP is that it is slow because it needs to serialize all calls into a text format (XML).

You can see a list of services at http://localhost:8080/api/axis. Set the property axis.servlet.hosts.allowed in portal.properties to configure security.

The SOAP utility is only generated for remote services.

Author:

Brian Wing Shun Chan

See Also:

AssetCategoryServiceHttp

Generated:

Constructor Summary

Constructors

Constructor and Description
AssetCategoryServiceSoap()

Method Summary

Modifier and Type	Method and Description
static com.liferay.asset.kernel.model.AssetCategorySoap	addCategory(long groupId, long parentCategoryId, java.lang.String[] titleMapLanguageIds, java.lang.String[] titleMapValues, java.lang.String[] descriptionMapLanguageIds, java.lang.String[] descriptionMapValues, long vocabularyId, java.lang.String[] categoryProperties, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static com.liferay.asset.kernel.model.AssetCategorySoap	addCategory(long groupId, java.lang.String title, long vocabularyId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static void	deleteCategories(long[] categoryIds)
static com.liferay.asset.kernel.model.AssetCategorySoap[]	deleteCategories(long[] categoryIds, com.liferay.portal.kernel.service.ServiceContext serviceContext) Deprecated. As of Wilberforce (7.0.x), Replaced by deleteCategories(long[])
static void	deleteCategory(long categoryId)
static com.liferay.asset.kernel.model.AssetCategorySoap	fetchCategory(long categoryId)
static com.liferay.asset.kernel.model.AssetCategorySoap[]	getCategories(long classNameId, long classPK, int start, int end) Returns a range of assetCategories related to an AssetEntry with the given "classNameId-classPK".
static com.liferay.asset.kernel.model.AssetCategorySoap[]	getCategories(java.lang.String className, long classPK)
static int	getCategoriesCount(long classNameId, long classPK) Returns the number of assetCategories related to an AssetEntry with the given "classNameId-classPK".
static com.liferay.asset.kernel.model.AssetCategorySoap	getCategory(long categoryId)
static java.lang.String	getCategoryPath(long categoryId)
static com.liferay.asset.kernel.model.AssetCategorySoap[]	getChildCategories(long parentCategoryId)
static com.liferay.asset.kernel.model.AssetCategorySoap[]	getChildCategories(long parentCategoryId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.asset.kernel.model.AssetCategory> obc) eturns a range of child assetCategories.
static int	getChildCategoriesCount(long parentCategoryId) Returns the number of child categories
static com.liferay.asset.kernel.model.AssetCategorySoap[]	getVocabularyCategories(long vocabularyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.asset.kernel.model.AssetCategory> obc)
static com.liferay.asset.kernel.model.AssetCategorySoap[]	getVocabularyCategories(long parentCategoryId, long vocabularyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.asset.kernel.model.AssetCategory> obc)
static com.liferay.asset.kernel.model.AssetCategorySoap[]	getVocabularyCategories(long groupId, long parentCategoryId, long vocabularyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.asset.kernel.model.AssetCategory> obc)
static com.liferay.asset.kernel.model.AssetCategorySoap[]	getVocabularyCategories(long groupId, java.lang.String name, long vocabularyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.asset.kernel.model.AssetCategory> obc)
static int	getVocabularyCategoriesCount(long groupId, long vocabularyId)
static int	getVocabularyCategoriesCount(long groupId, long parentCategory, long vocabularyId)
static int	getVocabularyCategoriesCount(long groupId, java.lang.String name, long vocabularyId)
static com.liferay.asset.kernel.model.AssetCategoryDisplay	getVocabularyCategoriesDisplay(long vocabularyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.asset.kernel.model.AssetCategory> obc)
static com.liferay.asset.kernel.model.AssetCategoryDisplay	getVocabularyCategoriesDisplay(long groupId, java.lang.String name, long vocabularyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.asset.kernel.model.AssetCategory> obc)
static com.liferay.asset.kernel.model.AssetCategorySoap[]	getVocabularyRootCategories(long groupId, long vocabularyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.asset.kernel.model.AssetCategory> obc)
static int	getVocabularyRootCategoriesCount(long groupId, long vocabularyId)
static com.liferay.asset.kernel.model.AssetCategorySoap	moveCategory(long categoryId, long parentCategoryId, long vocabularyId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static java.lang.String	search(long[] groupIds, java.lang.String name, long[] vocabularyIds, int start, int end)
static com.liferay.asset.kernel.model.AssetCategorySoap[]	search(long groupId, java.lang.String keywords, long vocabularyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.asset.kernel.model.AssetCategory> obc)
static java.lang.String	search(long groupId, java.lang.String name, java.lang.String[] categoryProperties, int start, int end)
static com.liferay.asset.kernel.model.AssetCategoryDisplay	searchCategoriesDisplay(long[] groupIds, java.lang.String title, long[] vocabularyIds, int start, int end)
static com.liferay.asset.kernel.model.AssetCategoryDisplay	searchCategoriesDisplay(long[] groupIds, java.lang.String title, long[] parentCategoryIds, long[] vocabularyIds, int start, int end)
static com.liferay.asset.kernel.model.AssetCategoryDisplay	searchCategoriesDisplay(long[] groupIds, java.lang.String title, long[] vocabularyIds, long[] parentCategoryIds, int start, int end, com.liferay.portal.kernel.search.Sort sort)
static com.liferay.asset.kernel.model.AssetCategoryDisplay	searchCategoriesDisplay(long groupId, java.lang.String title, long vocabularyId, int start, int end)
static com.liferay.asset.kernel.model.AssetCategoryDisplay	searchCategoriesDisplay(long groupId, java.lang.String title, long parentCategoryId, long vocabularyId, int start, int end)
static com.liferay.asset.kernel.model.AssetCategoryDisplay	searchCategoriesDisplay(long groupId, java.lang.String title, long vocabularyId, long parentCategoryId, int start, int end, com.liferay.portal.kernel.search.Sort sort)
static com.liferay.asset.kernel.model.AssetCategorySoap	updateCategory(long categoryId, long parentCategoryId, java.lang.String[] titleMapLanguageIds, java.lang.String[] titleMapValues, java.lang.String[] descriptionMapLanguageIds, java.lang.String[] descriptionMapValues, long vocabularyId, java.lang.String[] categoryProperties, com.liferay.portal.kernel.service.ServiceContext serviceContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AssetCategoryServiceSoap

public AssetCategoryServiceSoap()

Method Detail

addCategory

public static com.liferay.asset.kernel.model.AssetCategorySoap addCategory(long groupId,
                                                                           long parentCategoryId,
                                                                           java.lang.String[] titleMapLanguageIds,
                                                                           java.lang.String[] titleMapValues,
                                                                           java.lang.String[] descriptionMapLanguageIds,
                                                                           java.lang.String[] descriptionMapValues,
                                                                           long vocabularyId,
                                                                           java.lang.String[] categoryProperties,
                                                                           com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                    throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

addCategory

public static com.liferay.asset.kernel.model.AssetCategorySoap addCategory(long groupId,
                                                                           java.lang.String title,
                                                                           long vocabularyId,
                                                                           com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                    throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

deleteCategories

public static void deleteCategories(long[] categoryIds)
                             throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

deleteCategories

@Deprecated
public static com.liferay.asset.kernel.model.AssetCategorySoap[] deleteCategories(long[] categoryIds,
                                                                                              com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                                       throws java.rmi.RemoteException

Deprecated. As of Wilberforce (7.0.x), Replaced by deleteCategories(long[])

Throws:

java.rmi.RemoteException

deleteCategory

public static void deleteCategory(long categoryId)
                           throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

fetchCategory

public static com.liferay.asset.kernel.model.AssetCategorySoap fetchCategory(long categoryId)
                                                                      throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getCategories

public static com.liferay.asset.kernel.model.AssetCategorySoap[] getCategories(long classNameId,
                                                                               long classPK,
                                                                               int start,
                                                                               int end)
                                                                        throws java.rmi.RemoteException

Returns a range of assetCategories related to an AssetEntry with the given "classNameId-classPK".

Parameters:

classNameId - the className of the asset

classPK - the classPK of the asset

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the matching assetCategories

Throws:

java.rmi.RemoteException

getCategories

public static com.liferay.asset.kernel.model.AssetCategorySoap[] getCategories(java.lang.String className,
                                                                               long classPK)
                                                                        throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getCategoriesCount

public static int getCategoriesCount(long classNameId,
                                     long classPK)
                              throws java.rmi.RemoteException

Returns the number of assetCategories related to an AssetEntry with the given "classNameId-classPK".

Parameters:

classNameId - the className of the asset

classPK - the classPK of the asset

Returns:

the number of matching assetCategories

Throws:

java.rmi.RemoteException

getCategory

public static com.liferay.asset.kernel.model.AssetCategorySoap getCategory(long categoryId)
                                                                    throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getCategoryPath

public static java.lang.String getCategoryPath(long categoryId)
                                        throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getChildCategories

public static com.liferay.asset.kernel.model.AssetCategorySoap[] getChildCategories(long parentCategoryId)
                                                                             throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getChildCategories

public static com.liferay.asset.kernel.model.AssetCategorySoap[] getChildCategories(long parentCategoryId,
                                                                                    int start,
                                                                                    int end,
                                                                                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.asset.kernel.model.AssetCategory> obc)
                                                                             throws java.rmi.RemoteException

eturns a range of child assetCategories.

Parameters:

parentCategoryId - the parent category ID

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

obc - the comparator

Returns:

the matching categories

Throws:

PortalException

java.rmi.RemoteException

getChildCategoriesCount

public static int getChildCategoriesCount(long parentCategoryId)
                                   throws java.rmi.RemoteException

Returns the number of child categories

Parameters:

parentCategoryId - the parent category ID

Returns:

the number of child categories

Throws:

PortalException

java.rmi.RemoteException

getVocabularyCategories

public static com.liferay.asset.kernel.model.AssetCategorySoap[] getVocabularyCategories(long vocabularyId,
                                                                                         int start,
                                                                                         int end,
                                                                                         com.liferay.portal.kernel.util.OrderByComparator<com.liferay.asset.kernel.model.AssetCategory> obc)
                                                                                  throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getVocabularyCategories

public static com.liferay.asset.kernel.model.AssetCategorySoap[] getVocabularyCategories(long parentCategoryId,
                                                                                         long vocabularyId,
                                                                                         int start,
                                                                                         int end,
                                                                                         com.liferay.portal.kernel.util.OrderByComparator<com.liferay.asset.kernel.model.AssetCategory> obc)
                                                                                  throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getVocabularyCategories

public static com.liferay.asset.kernel.model.AssetCategorySoap[] getVocabularyCategories(long groupId,
                                                                                         long parentCategoryId,
                                                                                         long vocabularyId,
                                                                                         int start,
                                                                                         int end,
                                                                                         com.liferay.portal.kernel.util.OrderByComparator<com.liferay.asset.kernel.model.AssetCategory> obc)
                                                                                  throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getVocabularyCategories

public static com.liferay.asset.kernel.model.AssetCategorySoap[] getVocabularyCategories(long groupId,
                                                                                         java.lang.String name,
                                                                                         long vocabularyId,
                                                                                         int start,
                                                                                         int end,
                                                                                         com.liferay.portal.kernel.util.OrderByComparator<com.liferay.asset.kernel.model.AssetCategory> obc)
                                                                                  throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getVocabularyCategoriesCount

public static int getVocabularyCategoriesCount(long groupId,
                                               long vocabularyId)
                                        throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getVocabularyCategoriesCount

public static int getVocabularyCategoriesCount(long groupId,
                                               long parentCategory,
                                               long vocabularyId)
                                        throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getVocabularyCategoriesCount

public static int getVocabularyCategoriesCount(long groupId,
                                               java.lang.String name,
                                               long vocabularyId)
                                        throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getVocabularyCategoriesDisplay

public static com.liferay.asset.kernel.model.AssetCategoryDisplay getVocabularyCategoriesDisplay(long vocabularyId,
                                                                                                 int start,
                                                                                                 int end,
                                                                                                 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.asset.kernel.model.AssetCategory> obc)
                                                                                          throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getVocabularyCategoriesDisplay

public static com.liferay.asset.kernel.model.AssetCategoryDisplay getVocabularyCategoriesDisplay(long groupId,
                                                                                                 java.lang.String name,
                                                                                                 long vocabularyId,
                                                                                                 int start,
                                                                                                 int end,
                                                                                                 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.asset.kernel.model.AssetCategory> obc)
                                                                                          throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getVocabularyRootCategories

public static com.liferay.asset.kernel.model.AssetCategorySoap[] getVocabularyRootCategories(long groupId,
                                                                                             long vocabularyId,
                                                                                             int start,
                                                                                             int end,
                                                                                             com.liferay.portal.kernel.util.OrderByComparator<com.liferay.asset.kernel.model.AssetCategory> obc)
                                                                                      throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getVocabularyRootCategoriesCount

public static int getVocabularyRootCategoriesCount(long groupId,
                                                   long vocabularyId)
                                            throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

moveCategory

public static com.liferay.asset.kernel.model.AssetCategorySoap moveCategory(long categoryId,
                                                                            long parentCategoryId,
                                                                            long vocabularyId,
                                                                            com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                     throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

search

public static com.liferay.asset.kernel.model.AssetCategorySoap[] search(long groupId,
                                                                        java.lang.String keywords,
                                                                        long vocabularyId,
                                                                        int start,
                                                                        int end,
                                                                        com.liferay.portal.kernel.util.OrderByComparator<com.liferay.asset.kernel.model.AssetCategory> obc)
                                                                 throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

search

public static java.lang.String search(long groupId,
                                      java.lang.String name,
                                      java.lang.String[] categoryProperties,
                                      int start,
                                      int end)
                               throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

search

public static java.lang.String search(long[] groupIds,
                                      java.lang.String name,
                                      long[] vocabularyIds,
                                      int start,
                                      int end)
                               throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

searchCategoriesDisplay

public static com.liferay.asset.kernel.model.AssetCategoryDisplay searchCategoriesDisplay(long groupId,
                                                                                          java.lang.String title,
                                                                                          long vocabularyId,
                                                                                          int start,
                                                                                          int end)
                                                                                   throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

searchCategoriesDisplay

public static com.liferay.asset.kernel.model.AssetCategoryDisplay searchCategoriesDisplay(long groupId,
                                                                                          java.lang.String title,
                                                                                          long parentCategoryId,
                                                                                          long vocabularyId,
                                                                                          int start,
                                                                                          int end)
                                                                                   throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

searchCategoriesDisplay

public static com.liferay.asset.kernel.model.AssetCategoryDisplay searchCategoriesDisplay(long groupId,
                                                                                          java.lang.String title,
                                                                                          long vocabularyId,
                                                                                          long parentCategoryId,
                                                                                          int start,
                                                                                          int end,
                                                                                          com.liferay.portal.kernel.search.Sort sort)
                                                                                   throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

searchCategoriesDisplay

public static com.liferay.asset.kernel.model.AssetCategoryDisplay searchCategoriesDisplay(long[] groupIds,
                                                                                          java.lang.String title,
                                                                                          long[] vocabularyIds,
                                                                                          int start,
                                                                                          int end)
                                                                                   throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

searchCategoriesDisplay

public static com.liferay.asset.kernel.model.AssetCategoryDisplay searchCategoriesDisplay(long[] groupIds,
                                                                                          java.lang.String title,
                                                                                          long[] parentCategoryIds,
                                                                                          long[] vocabularyIds,
                                                                                          int start,
                                                                                          int end)
                                                                                   throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

searchCategoriesDisplay

public static com.liferay.asset.kernel.model.AssetCategoryDisplay searchCategoriesDisplay(long[] groupIds,
                                                                                          java.lang.String title,
                                                                                          long[] vocabularyIds,
                                                                                          long[] parentCategoryIds,
                                                                                          int start,
                                                                                          int end,
                                                                                          com.liferay.portal.kernel.search.Sort sort)
                                                                                   throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

updateCategory

public static com.liferay.asset.kernel.model.AssetCategorySoap updateCategory(long categoryId,
                                                                              long parentCategoryId,
                                                                              java.lang.String[] titleMapLanguageIds,
                                                                              java.lang.String[] titleMapValues,
                                                                              java.lang.String[] descriptionMapLanguageIds,
                                                                              java.lang.String[] descriptionMapValues,
                                                                              long vocabularyId,
                                                                              java.lang.String[] categoryProperties,
                                                                              com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                       throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException