Liferay 6.1.2-ce-ga3

com.liferay.portlet.journal.service
Interface JournalArticleService

All Superinterfaces:
BaseService
All Known Implementing Classes:
JournalArticleServiceBaseImpl, JournalArticleServiceImpl, JournalArticleServiceWrapper

@JSONWebService
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface JournalArticleService
extends BaseService

The interface for the journal article remote service.

This is a remote service. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

See Also:
JournalArticleServiceUtil, JournalArticleServiceBaseImpl, JournalArticleServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 JournalArticle addArticle(long groupId, long classNameId, long classPK, String articleId, boolean autoArticleId, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, 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, boolean smallImage, String smallImageURL, File smallFile, Map<String,byte[]> images, String articleURL, ServiceContext serviceContext)
           
 JournalArticle addArticle(long groupId, long classNameId, long classPK, String articleId, boolean autoArticleId, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, 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)
           
 JournalArticle copyArticle(long groupId, String oldArticleId, String newArticleId, boolean autoArticleId, double version)
           
 void deleteArticle(long groupId, String articleId, double version, String articleURL, ServiceContext serviceContext)
           
 void deleteArticle(long groupId, String articleId, String articleURL, ServiceContext serviceContext)
           
 JournalArticle expireArticle(long groupId, String articleId, double version, String articleURL, ServiceContext serviceContext)
           
 void expireArticle(long groupId, String articleId, String articleURL, ServiceContext serviceContext)
           
 JournalArticle getArticle(long id)
           
 JournalArticle getArticle(long groupId, String articleId)
           
 JournalArticle getArticle(long groupId, String articleId, double version)
           
 JournalArticle getArticle(long groupId, String className, long classPK)
           
 JournalArticle getArticleByUrlTitle(long groupId, String urlTitle)
           
 String getArticleContent(long groupId, String articleId, double version, String languageId, ThemeDisplay themeDisplay)
           
 String getArticleContent(long groupId, String articleId, String languageId, ThemeDisplay themeDisplay)
           
 List<JournalArticle> getArticlesByArticleId(long groupId, String articleId, int start, int end, OrderByComparator obc)
           
 List<JournalArticle> getArticlesByLayoutUuid(long groupId, String layoutUuid)
           
 int getArticlesCountByArticleId(long groupId, String articleId)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 JournalArticle getDisplayArticleByUrlTitle(long groupId, String urlTitle)
           
 JournalArticle getLatestArticle(long resourcePrimKey)
           
 JournalArticle getLatestArticle(long groupId, String articleId, int status)
           
 JournalArticle getLatestArticle(long groupId, String className, long classPK)
           
 void removeArticleLocale(long companyId, String languageId)
           
 JournalArticle removeArticleLocale(long groupId, String articleId, double version, String languageId)
           
 List<JournalArticle> 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)
           
 List<JournalArticle> 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)
           
 List<JournalArticle> 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)
           
 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)
           
 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)
           
 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)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void subscribe(long groupId)
           
 void unsubscribe(long groupId)
           
 JournalArticle updateArticle(long userId, long groupId, String articleId, double version, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String content, String layoutUuid, ServiceContext serviceContext)
           
 JournalArticle updateArticle(long groupId, String articleId, double version, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, 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, boolean smallImage, String smallImageURL, File smallFile, Map<String,byte[]> images, String articleURL, ServiceContext serviceContext)
           
 JournalArticle updateArticle(long groupId, String articleId, double version, String content, ServiceContext serviceContext)
           
 JournalArticle updateArticleTranslation(long groupId, String articleId, double version, Locale locale, String title, String description, String content, Map<String,byte[]> images)
          Deprecated. updateArticleTranslation(long, String, double, Locale, String, String, String, Map, ServiceContext)
 JournalArticle updateArticleTranslation(long groupId, String articleId, double version, Locale locale, String title, String description, String content, Map<String,byte[]> images, ServiceContext serviceContext)
           
 JournalArticle updateContent(long groupId, String articleId, double version, String content)
           
 JournalArticle updateStatus(long groupId, String articleId, double version, int status, String articleURL, ServiceContext serviceContext)
           
 

Method Detail

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addArticle

JournalArticle addArticle(long groupId,
                          long classNameId,
                          long classPK,
                          String articleId,
                          boolean autoArticleId,
                          Map<Locale,String> titleMap,
                          Map<Locale,String> descriptionMap,
                          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,
                          boolean smallImage,
                          String smallImageURL,
                          File smallFile,
                          Map<String,byte[]> images,
                          String articleURL,
                          ServiceContext serviceContext)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

addArticle

JournalArticle addArticle(long groupId,
                          long classNameId,
                          long classPK,
                          String articleId,
                          boolean autoArticleId,
                          Map<Locale,String> titleMap,
                          Map<Locale,String> descriptionMap,
                          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 PortalException,
                                 SystemException
Throws:
PortalException
SystemException

copyArticle

JournalArticle copyArticle(long groupId,
                           String oldArticleId,
                           String newArticleId,
                           boolean autoArticleId,
                           double version)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

deleteArticle

void deleteArticle(long groupId,
                   String articleId,
                   double version,
                   String articleURL,
                   ServiceContext serviceContext)
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

deleteArticle

void deleteArticle(long groupId,
                   String articleId,
                   String articleURL,
                   ServiceContext serviceContext)
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

expireArticle

JournalArticle expireArticle(long groupId,
                             String articleId,
                             double version,
                             String articleURL,
                             ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

expireArticle

void expireArticle(long groupId,
                   String articleId,
                   String articleURL,
                   ServiceContext serviceContext)
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

getArticle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalArticle getArticle(long id)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

getArticle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalArticle getArticle(long groupId,
                                                                   String articleId)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

getArticle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalArticle getArticle(long groupId,
                                                                   String articleId,
                                                                   double version)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

getArticle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalArticle getArticle(long groupId,
                                                                   String className,
                                                                   long classPK)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

getArticleByUrlTitle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalArticle getArticleByUrlTitle(long groupId,
                                                                             String urlTitle)
                                    throws PortalException,
                                           SystemException
Throws:
PortalException
SystemException

getArticleContent

@Transactional(propagation=SUPPORTS,
               readOnly=true)
String getArticleContent(long groupId,
                                                                  String articleId,
                                                                  double version,
                                                                  String languageId,
                                                                  ThemeDisplay themeDisplay)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

getArticleContent

@Transactional(propagation=SUPPORTS,
               readOnly=true)
String getArticleContent(long groupId,
                                                                  String articleId,
                                                                  String languageId,
                                                                  ThemeDisplay themeDisplay)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

getArticlesByArticleId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<JournalArticle> getArticlesByArticleId(long groupId,
                                                                                     String articleId,
                                                                                     int start,
                                                                                     int end,
                                                                                     OrderByComparator obc)
                                            throws SystemException
Throws:
SystemException

getArticlesByLayoutUuid

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<JournalArticle> getArticlesByLayoutUuid(long groupId,
                                                                                      String layoutUuid)
                                             throws SystemException
Throws:
SystemException

getArticlesCountByArticleId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getArticlesCountByArticleId(long groupId,
                                                                         String articleId)
                                throws SystemException
Throws:
SystemException

getDisplayArticleByUrlTitle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalArticle getDisplayArticleByUrlTitle(long groupId,
                                                                                    String urlTitle)
                                           throws PortalException,
                                                  SystemException
Throws:
PortalException
SystemException

getLatestArticle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalArticle getLatestArticle(long resourcePrimKey)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

getLatestArticle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalArticle getLatestArticle(long groupId,
                                                                         String articleId,
                                                                         int status)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

getLatestArticle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalArticle getLatestArticle(long groupId,
                                                                         String className,
                                                                         long classPK)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

removeArticleLocale

void removeArticleLocale(long companyId,
                         String languageId)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

removeArticleLocale

JournalArticle removeArticleLocale(long groupId,
                                   String articleId,
                                   double version,
                                   String languageId)
                                   throws PortalException,
                                          SystemException
Throws:
PortalException
SystemException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<JournalArticle> 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 SystemException
Throws:
SystemException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<JournalArticle> 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 SystemException
Throws:
SystemException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<JournalArticle> 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 SystemException
Throws:
SystemException

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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 SystemException
Throws:
SystemException

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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 SystemException
Throws:
SystemException

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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 SystemException
Throws:
SystemException

subscribe

void subscribe(long groupId)
               throws PortalException,
                      SystemException
Throws:
PortalException
SystemException

unsubscribe

void unsubscribe(long groupId)
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

updateArticle

JournalArticle updateArticle(long userId,
                             long groupId,
                             String articleId,
                             double version,
                             Map<Locale,String> titleMap,
                             Map<Locale,String> descriptionMap,
                             String content,
                             String layoutUuid,
                             ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

updateArticle

JournalArticle updateArticle(long groupId,
                             String articleId,
                             double version,
                             Map<Locale,String> titleMap,
                             Map<Locale,String> descriptionMap,
                             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,
                             boolean smallImage,
                             String smallImageURL,
                             File smallFile,
                             Map<String,byte[]> images,
                             String articleURL,
                             ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

updateArticle

JournalArticle updateArticle(long groupId,
                             String articleId,
                             double version,
                             String content,
                             ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

updateArticleTranslation

JournalArticle updateArticleTranslation(long groupId,
                                        String articleId,
                                        double version,
                                        Locale locale,
                                        String title,
                                        String description,
                                        String content,
                                        Map<String,byte[]> images)
                                        throws PortalException,
                                               SystemException
Deprecated. updateArticleTranslation(long, String, double, Locale, String, String, String, Map, ServiceContext)

Throws:
PortalException
SystemException

updateArticleTranslation

JournalArticle updateArticleTranslation(long groupId,
                                        String articleId,
                                        double version,
                                        Locale locale,
                                        String title,
                                        String description,
                                        String content,
                                        Map<String,byte[]> images,
                                        ServiceContext serviceContext)
                                        throws PortalException,
                                               SystemException
Throws:
PortalException
SystemException

updateContent

JournalArticle updateContent(long groupId,
                             String articleId,
                             double version,
                             String content)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

updateStatus

JournalArticle updateStatus(long groupId,
                            String articleId,
                            double version,
                            int status,
                            String articleURL,
                            ServiceContext serviceContext)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

Liferay 6.1.2-ce-ga3