Liferay 6.1.2-ce-ga3

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

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

public class MBMessageServiceSoap
extends Object

This class provides a SOAP utility for the MBMessageServiceUtil 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 MBMessageSoap. If the method in the service utility returns a MBMessage, that is translated to a MBMessageSoap. 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:
MBMessageServiceHttp, MBMessageSoap, MBMessageServiceUtil
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
MBMessageServiceSoap()
           
 
Method Summary
static MBMessageSoap addDiscussionMessage(long groupId, String className, long classPK, String permissionClassName, long permissionClassPK, long permissionOwnerId, long threadId, long parentMessageId, String subject, String body, ServiceContext serviceContext)
           
static MBMessageSoap addMessage(long groupId, long categoryId, long threadId, long parentMessageId, String subject, String body, String format, List<ObjectValuePair<String,InputStream>> inputStreamOVPs, boolean anonymous, double priority, boolean allowPingbacks, ServiceContext serviceContext)
          Deprecated. addMessage(long, String, String, String, java.util.List, boolean, double, boolean, com.liferay.portal.service.ServiceContext)
static MBMessageSoap addMessage(long groupId, long categoryId, String subject, String body, String format, List<ObjectValuePair<String,InputStream>> inputStreamOVPs, boolean anonymous, double priority, boolean allowPingbacks, ServiceContext serviceContext)
           
static MBMessageSoap addMessage(long parentMessageId, String subject, String body, String format, List<ObjectValuePair<String,InputStream>> inputStreamOVPs, boolean anonymous, double priority, boolean allowPingbacks, ServiceContext serviceContext)
           
static void deleteDiscussionMessage(long groupId, String className, long classPK, String permissionClassName, long permissionClassPK, long permissionOwnerId, long messageId)
           
static void deleteMessage(long messageId)
           
static MBMessageSoap[] getCategoryMessages(long groupId, long categoryId, int status, int start, int end)
           
static int getCategoryMessagesCount(long groupId, long categoryId, int status)
           
static int getGroupMessagesCount(long groupId, int status)
           
static MBMessageSoap getMessage(long messageId)
           
static int getThreadAnswersCount(long groupId, long categoryId, long threadId)
           
static MBMessageSoap[] getThreadMessages(long groupId, long categoryId, long threadId, int status, int start, int end)
           
static int getThreadMessagesCount(long groupId, long categoryId, long threadId, int status)
           
static void subscribeMessage(long messageId)
           
static void unsubscribeMessage(long messageId)
           
static void updateAnswer(long messageId, boolean answer, boolean cascade)
           
static MBMessageSoap updateDiscussionMessage(String className, long classPK, String permissionClassName, long permissionClassPK, long permissionOwnerId, long messageId, String subject, String body, ServiceContext serviceContext)
           
static MBMessageSoap updateMessage(long messageId, String subject, String body, List<ObjectValuePair<String,InputStream>> inputStreamOVPs, List<String> existingFiles, double priority, boolean allowPingbacks, ServiceContext serviceContext)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MBMessageServiceSoap

public MBMessageServiceSoap()
Method Detail

addDiscussionMessage

public static MBMessageSoap addDiscussionMessage(long groupId,
                                                 String className,
                                                 long classPK,
                                                 String permissionClassName,
                                                 long permissionClassPK,
                                                 long permissionOwnerId,
                                                 long threadId,
                                                 long parentMessageId,
                                                 String subject,
                                                 String body,
                                                 ServiceContext serviceContext)
                                          throws RemoteException
Throws:
RemoteException

addMessage

public static MBMessageSoap addMessage(long groupId,
                                       long categoryId,
                                       long threadId,
                                       long parentMessageId,
                                       String subject,
                                       String body,
                                       String format,
                                       List<ObjectValuePair<String,InputStream>> inputStreamOVPs,
                                       boolean anonymous,
                                       double priority,
                                       boolean allowPingbacks,
                                       ServiceContext serviceContext)
                                throws RemoteException
Deprecated. addMessage(long, String, String, String, java.util.List, boolean, double, boolean, com.liferay.portal.service.ServiceContext)

Throws:
RemoteException

addMessage

public static MBMessageSoap addMessage(long groupId,
                                       long categoryId,
                                       String subject,
                                       String body,
                                       String format,
                                       List<ObjectValuePair<String,InputStream>> inputStreamOVPs,
                                       boolean anonymous,
                                       double priority,
                                       boolean allowPingbacks,
                                       ServiceContext serviceContext)
                                throws RemoteException
Throws:
RemoteException

addMessage

public static MBMessageSoap addMessage(long parentMessageId,
                                       String subject,
                                       String body,
                                       String format,
                                       List<ObjectValuePair<String,InputStream>> inputStreamOVPs,
                                       boolean anonymous,
                                       double priority,
                                       boolean allowPingbacks,
                                       ServiceContext serviceContext)
                                throws RemoteException
Throws:
RemoteException

deleteDiscussionMessage

public static void deleteDiscussionMessage(long groupId,
                                           String className,
                                           long classPK,
                                           String permissionClassName,
                                           long permissionClassPK,
                                           long permissionOwnerId,
                                           long messageId)
                                    throws RemoteException
Throws:
RemoteException

deleteMessage

public static void deleteMessage(long messageId)
                          throws RemoteException
Throws:
RemoteException

getCategoryMessages

public static MBMessageSoap[] getCategoryMessages(long groupId,
                                                  long categoryId,
                                                  int status,
                                                  int start,
                                                  int end)
                                           throws RemoteException
Throws:
RemoteException

getCategoryMessagesCount

public static int getCategoryMessagesCount(long groupId,
                                           long categoryId,
                                           int status)
                                    throws RemoteException
Throws:
RemoteException

getGroupMessagesCount

public static int getGroupMessagesCount(long groupId,
                                        int status)
                                 throws RemoteException
Throws:
RemoteException

getMessage

public static MBMessageSoap getMessage(long messageId)
                                throws RemoteException
Throws:
RemoteException

getThreadAnswersCount

public static int getThreadAnswersCount(long groupId,
                                        long categoryId,
                                        long threadId)
                                 throws RemoteException
Throws:
RemoteException

getThreadMessages

public static MBMessageSoap[] getThreadMessages(long groupId,
                                                long categoryId,
                                                long threadId,
                                                int status,
                                                int start,
                                                int end)
                                         throws RemoteException
Throws:
RemoteException

getThreadMessagesCount

public static int getThreadMessagesCount(long groupId,
                                         long categoryId,
                                         long threadId,
                                         int status)
                                  throws RemoteException
Throws:
RemoteException

subscribeMessage

public static void subscribeMessage(long messageId)
                             throws RemoteException
Throws:
RemoteException

unsubscribeMessage

public static void unsubscribeMessage(long messageId)
                               throws RemoteException
Throws:
RemoteException

updateAnswer

public static void updateAnswer(long messageId,
                                boolean answer,
                                boolean cascade)
                         throws RemoteException
Throws:
RemoteException

updateDiscussionMessage

public static MBMessageSoap updateDiscussionMessage(String className,
                                                    long classPK,
                                                    String permissionClassName,
                                                    long permissionClassPK,
                                                    long permissionOwnerId,
                                                    long messageId,
                                                    String subject,
                                                    String body,
                                                    ServiceContext serviceContext)
                                             throws RemoteException
Throws:
RemoteException

updateMessage

public static MBMessageSoap updateMessage(long messageId,
                                          String subject,
                                          String body,
                                          List<ObjectValuePair<String,InputStream>> inputStreamOVPs,
                                          List<String> existingFiles,
                                          double priority,
                                          boolean allowPingbacks,
                                          ServiceContext serviceContext)
                                   throws RemoteException
Throws:
RemoteException

Liferay 6.1.2-ce-ga3