Liferay 6.1.2-ce-ga3

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

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

public class JournalArticleServiceSoap
extends Object

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

Constructor Summary
JournalArticleServiceSoap()
           
 
Method Summary
static JournalArticleSoap addArticle(long groupId, long classNameId, long classPK, String articleId, boolean autoArticleId, String[] titleMapLanguageIds, String[] titleMapValues, String[] descriptionMapLanguageIds, String[] descriptionMapValues, String content, String type, String structureId, String templateId, String layoutUuid, 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, String articleURL, ServiceContext serviceContext)
           
static JournalArticleSoap copyArticle(long groupId, String oldArticleId, String newArticleId, boolean autoArticleId, double version)
           
static void deleteArticle(long groupId, String articleId, double version, String articleURL, ServiceContext serviceContext)
           
static void deleteArticle(long groupId, String articleId, String articleURL, ServiceContext serviceContext)
           
static JournalArticleSoap expireArticle(long groupId, String articleId, double version, String articleURL, ServiceContext serviceContext)
           
static void expireArticle(long groupId, String articleId, String articleURL, ServiceContext serviceContext)
           
static JournalArticleSoap getArticle(long id)
           
static JournalArticleSoap getArticle(long groupId, String articleId)
           
static JournalArticleSoap getArticle(long groupId, String articleId, double version)
           
static JournalArticleSoap getArticle(long groupId, String className, long classPK)
           
static JournalArticleSoap getArticleByUrlTitle(long groupId, String urlTitle)
           
static JournalArticleSoap[] getArticlesByArticleId(long groupId, String articleId, int start, int end, OrderByComparator obc)
           
static JournalArticleSoap[] getArticlesByLayoutUuid(long groupId, String layoutUuid)
           
static int getArticlesCountByArticleId(long groupId, String articleId)
           
static JournalArticleSoap getDisplayArticleByUrlTitle(long groupId, String urlTitle)
           
static JournalArticleSoap getLatestArticle(long resourcePrimKey)
           
static JournalArticleSoap getLatestArticle(long groupId, String articleId, int status)
           
static JournalArticleSoap getLatestArticle(long groupId, String className, long classPK)
           
static void removeArticleLocale(long companyId, String languageId)
           
static JournalArticleSoap removeArticleLocale(long groupId, String articleId, double version, String languageId)
           
static JournalArticleSoap[] search(long companyId, long groupId, long classNameId, String keywords, Double version, String type, String structureId, String templateId, Date displayDateGT, Date displayDateLT, int status, Date reviewDate, int start, int end, OrderByComparator obc)
           
static JournalArticleSoap[] search(long companyId, long groupId, long classNameId, String articleId, Double version, String title, String description, String content, String type, String[] structureIds, String[] templateIds, Date displayDateGT, Date displayDateLT, int status, Date reviewDate, boolean andOperator, int start, int end, OrderByComparator obc)
           
static JournalArticleSoap[] search(long companyId, long groupId, long classNameId, String articleId, Double version, String title, String description, String content, String type, String structureId, String templateId, Date displayDateGT, Date displayDateLT, int status, Date reviewDate, boolean andOperator, int start, int end, OrderByComparator obc)
           
static int searchCount(long companyId, long groupId, long classNameId, String keywords, Double version, String type, String structureId, String templateId, Date displayDateGT, Date displayDateLT, int status, Date reviewDate)
           
static int searchCount(long companyId, long groupId, long classNameId, String articleId, Double version, String title, String description, String content, String type, String[] structureIds, String[] templateIds, Date displayDateGT, Date displayDateLT, int status, Date reviewDate, boolean andOperator)
           
static int searchCount(long companyId, long groupId, long classNameId, String articleId, Double version, String title, String description, String content, String type, String structureId, String templateId, Date displayDateGT, Date displayDateLT, int status, Date reviewDate, boolean andOperator)
           
static void subscribe(long groupId)
           
static void unsubscribe(long groupId)
           
static JournalArticleSoap updateArticle(long userId, long groupId, String articleId, double version, String[] titleMapLanguageIds, String[] titleMapValues, String[] descriptionMapLanguageIds, String[] descriptionMapValues, String content, String layoutUuid, ServiceContext serviceContext)
           
static JournalArticleSoap updateArticle(long groupId, String articleId, double version, String content, ServiceContext serviceContext)
           
static JournalArticleSoap updateContent(long groupId, String articleId, double version, String content)
           
static JournalArticleSoap updateStatus(long groupId, String articleId, double version, int status, String articleURL, ServiceContext serviceContext)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JournalArticleServiceSoap

public JournalArticleServiceSoap()
Method Detail

addArticle

public static JournalArticleSoap addArticle(long groupId,
                                            long classNameId,
                                            long classPK,
                                            String articleId,
                                            boolean autoArticleId,
                                            String[] titleMapLanguageIds,
                                            String[] titleMapValues,
                                            String[] descriptionMapLanguageIds,
                                            String[] descriptionMapValues,
                                            String content,
                                            String type,
                                            String structureId,
                                            String templateId,
                                            String layoutUuid,
                                            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,
                                            String articleURL,
                                            ServiceContext serviceContext)
                                     throws RemoteException
Throws:
RemoteException

copyArticle

public static JournalArticleSoap copyArticle(long groupId,
                                             String oldArticleId,
                                             String newArticleId,
                                             boolean autoArticleId,
                                             double version)
                                      throws RemoteException
Throws:
RemoteException

deleteArticle

public static void deleteArticle(long groupId,
                                 String articleId,
                                 double version,
                                 String articleURL,
                                 ServiceContext serviceContext)
                          throws RemoteException
Throws:
RemoteException

deleteArticle

public static void deleteArticle(long groupId,
                                 String articleId,
                                 String articleURL,
                                 ServiceContext serviceContext)
                          throws RemoteException
Throws:
RemoteException

expireArticle

public static JournalArticleSoap expireArticle(long groupId,
                                               String articleId,
                                               double version,
                                               String articleURL,
                                               ServiceContext serviceContext)
                                        throws RemoteException
Throws:
RemoteException

expireArticle

public static void expireArticle(long groupId,
                                 String articleId,
                                 String articleURL,
                                 ServiceContext serviceContext)
                          throws RemoteException
Throws:
RemoteException

getArticle

public static JournalArticleSoap getArticle(long id)
                                     throws RemoteException
Throws:
RemoteException

getArticle

public static JournalArticleSoap getArticle(long groupId,
                                            String articleId)
                                     throws RemoteException
Throws:
RemoteException

getArticle

public static JournalArticleSoap getArticle(long groupId,
                                            String articleId,
                                            double version)
                                     throws RemoteException
Throws:
RemoteException

getArticle

public static JournalArticleSoap getArticle(long groupId,
                                            String className,
                                            long classPK)
                                     throws RemoteException
Throws:
RemoteException

getArticleByUrlTitle

public static JournalArticleSoap getArticleByUrlTitle(long groupId,
                                                      String urlTitle)
                                               throws RemoteException
Throws:
RemoteException

getArticlesByArticleId

public static JournalArticleSoap[] getArticlesByArticleId(long groupId,
                                                          String articleId,
                                                          int start,
                                                          int end,
                                                          OrderByComparator obc)
                                                   throws RemoteException
Throws:
RemoteException

getArticlesByLayoutUuid

public static JournalArticleSoap[] getArticlesByLayoutUuid(long groupId,
                                                           String layoutUuid)
                                                    throws RemoteException
Throws:
RemoteException

getArticlesCountByArticleId

public static int getArticlesCountByArticleId(long groupId,
                                              String articleId)
                                       throws RemoteException
Throws:
RemoteException

getDisplayArticleByUrlTitle

public static JournalArticleSoap getDisplayArticleByUrlTitle(long groupId,
                                                             String urlTitle)
                                                      throws RemoteException
Throws:
RemoteException

getLatestArticle

public static JournalArticleSoap getLatestArticle(long resourcePrimKey)
                                           throws RemoteException
Throws:
RemoteException

getLatestArticle

public static JournalArticleSoap getLatestArticle(long groupId,
                                                  String articleId,
                                                  int status)
                                           throws RemoteException
Throws:
RemoteException

getLatestArticle

public static JournalArticleSoap getLatestArticle(long groupId,
                                                  String className,
                                                  long classPK)
                                           throws RemoteException
Throws:
RemoteException

removeArticleLocale

public static void removeArticleLocale(long companyId,
                                       String languageId)
                                throws RemoteException
Throws:
RemoteException

removeArticleLocale

public static JournalArticleSoap removeArticleLocale(long groupId,
                                                     String articleId,
                                                     double version,
                                                     String languageId)
                                              throws RemoteException
Throws:
RemoteException

search

public static JournalArticleSoap[] search(long companyId,
                                          long groupId,
                                          long classNameId,
                                          String keywords,
                                          Double version,
                                          String type,
                                          String structureId,
                                          String templateId,
                                          Date displayDateGT,
                                          Date displayDateLT,
                                          int status,
                                          Date reviewDate,
                                          int start,
                                          int end,
                                          OrderByComparator obc)
                                   throws RemoteException
Throws:
RemoteException

search

public static JournalArticleSoap[] search(long companyId,
                                          long groupId,
                                          long classNameId,
                                          String articleId,
                                          Double version,
                                          String title,
                                          String description,
                                          String content,
                                          String type,
                                          String structureId,
                                          String templateId,
                                          Date displayDateGT,
                                          Date displayDateLT,
                                          int status,
                                          Date reviewDate,
                                          boolean andOperator,
                                          int start,
                                          int end,
                                          OrderByComparator obc)
                                   throws RemoteException
Throws:
RemoteException

search

public static JournalArticleSoap[] search(long companyId,
                                          long groupId,
                                          long classNameId,
                                          String articleId,
                                          Double version,
                                          String title,
                                          String description,
                                          String content,
                                          String type,
                                          String[] structureIds,
                                          String[] templateIds,
                                          Date displayDateGT,
                                          Date displayDateLT,
                                          int status,
                                          Date reviewDate,
                                          boolean andOperator,
                                          int start,
                                          int end,
                                          OrderByComparator obc)
                                   throws RemoteException
Throws:
RemoteException

searchCount

public static int searchCount(long companyId,
                              long groupId,
                              long classNameId,
                              String keywords,
                              Double version,
                              String type,
                              String structureId,
                              String templateId,
                              Date displayDateGT,
                              Date displayDateLT,
                              int status,
                              Date reviewDate)
                       throws RemoteException
Throws:
RemoteException

searchCount

public static int searchCount(long companyId,
                              long groupId,
                              long classNameId,
                              String articleId,
                              Double version,
                              String title,
                              String description,
                              String content,
                              String type,
                              String structureId,
                              String templateId,
                              Date displayDateGT,
                              Date displayDateLT,
                              int status,
                              Date reviewDate,
                              boolean andOperator)
                       throws RemoteException
Throws:
RemoteException

searchCount

public static int searchCount(long companyId,
                              long groupId,
                              long classNameId,
                              String articleId,
                              Double version,
                              String title,
                              String description,
                              String content,
                              String type,
                              String[] structureIds,
                              String[] templateIds,
                              Date displayDateGT,
                              Date displayDateLT,
                              int status,
                              Date reviewDate,
                              boolean andOperator)
                       throws RemoteException
Throws:
RemoteException

subscribe

public static void subscribe(long groupId)
                      throws RemoteException
Throws:
RemoteException

unsubscribe

public static void unsubscribe(long groupId)
                        throws RemoteException
Throws:
RemoteException

updateArticle

public static JournalArticleSoap updateArticle(long userId,
                                               long groupId,
                                               String articleId,
                                               double version,
                                               String[] titleMapLanguageIds,
                                               String[] titleMapValues,
                                               String[] descriptionMapLanguageIds,
                                               String[] descriptionMapValues,
                                               String content,
                                               String layoutUuid,
                                               ServiceContext serviceContext)
                                        throws RemoteException
Throws:
RemoteException

updateArticle

public static JournalArticleSoap updateArticle(long groupId,
                                               String articleId,
                                               double version,
                                               String content,
                                               ServiceContext serviceContext)
                                        throws RemoteException
Throws:
RemoteException

updateContent

public static JournalArticleSoap updateContent(long groupId,
                                               String articleId,
                                               double version,
                                               String content)
                                        throws RemoteException
Throws:
RemoteException

updateStatus

public static JournalArticleSoap updateStatus(long groupId,
                                              String articleId,
                                              double version,
                                              int status,
                                              String articleURL,
                                              ServiceContext serviceContext)
                                       throws RemoteException
Throws:
RemoteException

Liferay 6.1.2-ce-ga3