Liferay 6.1.2-ce-ga3

com.liferay.portlet.messageboards.service.http
Class MBCategoryServiceSoap

java.lang.Object
  extended by com.liferay.portlet.messageboards.service.http.MBCategoryServiceSoap

public class MBCategoryServiceSoap
extends Object

This class provides a SOAP utility for the MBCategoryServiceUtil 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 SOAP to support certain types.

ServiceBuilder follows certain rules in translating the methods. For example, if the method in the service utility returns a List, that is translated to an array of MBCategorySoap. If the method in the service utility returns a MBCategory, that is translated to a MBCategorySoap. 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/secure/axis. Set the property axis.servlet.hosts.allowed in portal.properties to configure security.

The SOAP utility is only generated for remote services.

See Also:
MBCategoryServiceHttp, MBCategorySoap, MBCategoryServiceUtil
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
MBCategoryServiceSoap()
           
 
Method Summary
static MBCategorySoap addCategory(long parentCategoryId, String name, String description, String displayStyle, String emailAddress, String inProtocol, String inServerName, int inServerPort, boolean inUseSSL, String inUserName, String inPassword, int inReadInterval, String outEmailAddress, boolean outCustom, String outServerName, int outServerPort, boolean outUseSSL, String outUserName, String outPassword, boolean mailingListActive, boolean allowAnonymousEmail, ServiceContext serviceContext)
           
static void deleteCategory(long groupId, long categoryId)
           
static MBCategorySoap[] getCategories(long groupId)
           
static MBCategorySoap[] getCategories(long groupId, long[] parentCategoryIds, int start, int end)
           
static MBCategorySoap[] getCategories(long groupId, long parentCategoryId, int start, int end)
           
static int getCategoriesCount(long groupId, long parentCategoryId)
           
static int getCategoriesCount(long groupId, long[] parentCategoryIds)
           
static MBCategorySoap getCategory(long categoryId)
           
static long[] getCategoryIds(long groupId, long categoryId)
           
static Long[] getSubcategoryIds(Long[] categoryIds, long groupId, long categoryId)
           
static MBCategorySoap[] getSubscribedCategories(long groupId, long userId, int start, int end)
           
static int getSubscribedCategoriesCount(long groupId, long userId)
           
static void subscribeCategory(long groupId, long categoryId)
           
static void unsubscribeCategory(long groupId, long categoryId)
           
static MBCategorySoap updateCategory(long categoryId, long parentCategoryId, String name, String description, String displayStyle, String emailAddress, String inProtocol, String inServerName, int inServerPort, boolean inUseSSL, String inUserName, String inPassword, int inReadInterval, String outEmailAddress, boolean outCustom, String outServerName, int outServerPort, boolean outUseSSL, String outUserName, String outPassword, boolean mailingListActive, boolean allowAnonymousEmail, boolean mergeWithParentCategory, ServiceContext serviceContext)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MBCategoryServiceSoap

public MBCategoryServiceSoap()
Method Detail

addCategory

public static MBCategorySoap addCategory(long parentCategoryId,
                                         String name,
                                         String description,
                                         String displayStyle,
                                         String emailAddress,
                                         String inProtocol,
                                         String inServerName,
                                         int inServerPort,
                                         boolean inUseSSL,
                                         String inUserName,
                                         String inPassword,
                                         int inReadInterval,
                                         String outEmailAddress,
                                         boolean outCustom,
                                         String outServerName,
                                         int outServerPort,
                                         boolean outUseSSL,
                                         String outUserName,
                                         String outPassword,
                                         boolean mailingListActive,
                                         boolean allowAnonymousEmail,
                                         ServiceContext serviceContext)
                                  throws RemoteException
Throws:
RemoteException

deleteCategory

public static void deleteCategory(long groupId,
                                  long categoryId)
                           throws RemoteException
Throws:
RemoteException

getCategories

public static MBCategorySoap[] getCategories(long groupId)
                                      throws RemoteException
Throws:
RemoteException

getCategories

public static MBCategorySoap[] getCategories(long groupId,
                                             long parentCategoryId,
                                             int start,
                                             int end)
                                      throws RemoteException
Throws:
RemoteException

getCategories

public static MBCategorySoap[] getCategories(long groupId,
                                             long[] parentCategoryIds,
                                             int start,
                                             int end)
                                      throws RemoteException
Throws:
RemoteException

getCategoriesCount

public static int getCategoriesCount(long groupId,
                                     long parentCategoryId)
                              throws RemoteException
Throws:
RemoteException

getCategoriesCount

public static int getCategoriesCount(long groupId,
                                     long[] parentCategoryIds)
                              throws RemoteException
Throws:
RemoteException

getCategory

public static MBCategorySoap getCategory(long categoryId)
                                  throws RemoteException
Throws:
RemoteException

getCategoryIds

public static long[] getCategoryIds(long groupId,
                                    long categoryId)
                             throws RemoteException
Throws:
RemoteException

getSubcategoryIds

public static Long[] getSubcategoryIds(Long[] categoryIds,
                                       long groupId,
                                       long categoryId)
                                throws RemoteException
Throws:
RemoteException

getSubscribedCategories

public static MBCategorySoap[] getSubscribedCategories(long groupId,
                                                       long userId,
                                                       int start,
                                                       int end)
                                                throws RemoteException
Throws:
RemoteException

getSubscribedCategoriesCount

public static int getSubscribedCategoriesCount(long groupId,
                                               long userId)
                                        throws RemoteException
Throws:
RemoteException

subscribeCategory

public static void subscribeCategory(long groupId,
                                     long categoryId)
                              throws RemoteException
Throws:
RemoteException

unsubscribeCategory

public static void unsubscribeCategory(long groupId,
                                       long categoryId)
                                throws RemoteException
Throws:
RemoteException

updateCategory

public static MBCategorySoap updateCategory(long categoryId,
                                            long parentCategoryId,
                                            String name,
                                            String description,
                                            String displayStyle,
                                            String emailAddress,
                                            String inProtocol,
                                            String inServerName,
                                            int inServerPort,
                                            boolean inUseSSL,
                                            String inUserName,
                                            String inPassword,
                                            int inReadInterval,
                                            String outEmailAddress,
                                            boolean outCustom,
                                            String outServerName,
                                            int outServerPort,
                                            boolean outUseSSL,
                                            String outUserName,
                                            String outPassword,
                                            boolean mailingListActive,
                                            boolean allowAnonymousEmail,
                                            boolean mergeWithParentCategory,
                                            ServiceContext serviceContext)
                                     throws RemoteException
Throws:
RemoteException

Liferay 6.1.2-ce-ga3