com.liferay.knowledge.base.service

Interface KBArticleService

All Superinterfaces:

BaseService

All Known Implementing Classes:

KBArticleServiceWrapper

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

Provides the remote service interface for KBArticle. 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:

KBArticleServiceUtil

Method Summary

Modifier and Type	Method and Description
KBArticle	addKBArticle(java.lang.String portletId, long parentResourceClassNameId, long parentResourcePrimKey, java.lang.String title, java.lang.String urlTitle, java.lang.String content, java.lang.String description, java.lang.String sourceURL, java.lang.String[] sections, java.lang.String[] selectedFileNames, ServiceContext serviceContext)
int	addKBArticlesMarkdown(long groupId, long parentKBFolderId, java.lang.String fileName, boolean prioritizeByNumericalPrefix, java.io.InputStream inputStream, ServiceContext serviceContext)
void	addTempAttachment(long groupId, long resourcePrimKey, java.lang.String fileName, java.lang.String tempFolderName, java.io.InputStream inputStream, java.lang.String mimeType)
KBArticle	deleteKBArticle(long resourcePrimKey)
void	deleteKBArticles(long groupId, long[] resourcePrimKeys)
void	deleteTempAttachment(long groupId, long resourcePrimKey, java.lang.String fileName, java.lang.String tempFolderName)
KBArticle	fetchFirstChildKBArticle(long groupId, long parentResourcePrimKey)
KBArticle	fetchFirstChildKBArticle(long groupId, long parentResourcePrimKey, int status)
KBArticle	fetchKBArticleByUrlTitle(long groupId, long kbFolderId, java.lang.String urlTitle)
KBArticle	fetchLatestKBArticle(long resourcePrimKey, int status)
KBArticle	fetchLatestKBArticleByUrlTitle(long groupId, long kbFolderId, java.lang.String urlTitle, int status)
java.util.List<KBArticle>	getAllDescendantKBArticles(long groupId, long resourcePrimKey, int status, OrderByComparator<KBArticle> orderByComparator)
java.util.List<KBArticle>	getGroupKBArticles(long groupId, int status, int start, int end, OrderByComparator<KBArticle> orderByComparator)
int	getGroupKBArticlesCount(long groupId, int status)
java.lang.String	getGroupKBArticlesRSS(int status, int rssDelta, java.lang.String rssDisplayStyle, java.lang.String rssFormat, ThemeDisplay themeDisplay)
KBArticle	getKBArticle(long resourcePrimKey, int version)
java.util.List<KBArticle>	getKBArticleAndAllDescendantKBArticles(long resourcePrimKey, int status, OrderByComparator<KBArticle> orderByComparator)
java.lang.String	getKBArticleRSS(long resourcePrimKey, int status, int rssDelta, java.lang.String rssDisplayStyle, java.lang.String rssFormat, ThemeDisplay themeDisplay)
java.util.List<KBArticle>	getKBArticles(long groupId, long[] resourcePrimKeys, int status, int start, int end, OrderByComparator<KBArticle> orderByComparator)
java.util.List<KBArticle>	getKBArticles(long groupId, long[] resourcePrimKeys, int status, OrderByComparator<KBArticle> orderByComparator)
java.util.List<KBArticle>	getKBArticles(long groupId, long parentResourcePrimKey, int status, int start, int end, OrderByComparator<KBArticle> orderByComparator)
int	getKBArticlesCount(long groupId, long[] resourcePrimKeys, int status)
int	getKBArticlesCount(long groupId, long parentResourcePrimKey, int status)
KBArticleSearchDisplay	getKBArticleSearchDisplay(long groupId, java.lang.String title, java.lang.String content, int status, java.util.Date startDate, java.util.Date endDate, boolean andOperator, int[] curStartValues, int cur, int delta, OrderByComparator<KBArticle> orderByComparator)
java.util.List<KBArticle>	getKBArticleVersions(long groupId, long resourcePrimKey, int status, int start, int end, OrderByComparator<KBArticle> orderByComparator)
int	getKBArticleVersionsCount(long groupId, long resourcePrimKey, int status)
KBArticle	getLatestKBArticle(long resourcePrimKey, int status)
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
KBArticle[]	getPreviousAndNextKBArticles(long kbArticleId)
java.util.List<KBArticle>	getSectionsKBArticles(long groupId, java.lang.String[] sections, int status, int start, int end, OrderByComparator<KBArticle> orderByComparator)
int	getSectionsKBArticlesCount(long groupId, java.lang.String[] sections, int status)
java.lang.String[]	getTempAttachmentNames(long groupId, java.lang.String tempFolderName)
void	moveKBArticle(long resourcePrimKey, long parentResourceClassNameId, long parentResourcePrimKey, double priority)
KBArticle	revertKBArticle(long resourcePrimKey, int version, ServiceContext serviceContext)
void	subscribeGroupKBArticles(long groupId, java.lang.String portletId)
void	subscribeKBArticle(long groupId, long resourcePrimKey)
void	unsubscribeGroupKBArticles(long groupId, java.lang.String portletId)
void	unsubscribeKBArticle(long resourcePrimKey)
KBArticle	updateKBArticle(long resourcePrimKey, java.lang.String title, java.lang.String content, java.lang.String description, java.lang.String sourceURL, java.lang.String[] sections, java.lang.String[] selectedFileNames, long[] removeFileEntryIds, ServiceContext serviceContext)
void	updateKBArticlesPriorities(long groupId, java.util.Map<java.lang.Long,java.lang.Double> resourcePrimKeyToPriorityMap)

Method Detail

addKBArticle

KBArticle addKBArticle(java.lang.String portletId,
                       long parentResourceClassNameId,
                       long parentResourcePrimKey,
                       java.lang.String title,
                       java.lang.String urlTitle,
                       java.lang.String content,
                       java.lang.String description,
                       java.lang.String sourceURL,
                       java.lang.String[] sections,
                       java.lang.String[] selectedFileNames,
                       ServiceContext serviceContext)
                throws PortalException

Throws:

PortalException

addKBArticlesMarkdown

int addKBArticlesMarkdown(long groupId,
                          long parentKBFolderId,
                          java.lang.String fileName,
                          boolean prioritizeByNumericalPrefix,
                          java.io.InputStream inputStream,
                          ServiceContext serviceContext)
                   throws PortalException

Throws:

PortalException

addTempAttachment

void addTempAttachment(long groupId,
                       long resourcePrimKey,
                       java.lang.String fileName,
                       java.lang.String tempFolderName,
                       java.io.InputStream inputStream,
                       java.lang.String mimeType)
                throws PortalException

Throws:

PortalException

deleteKBArticle

KBArticle deleteKBArticle(long resourcePrimKey)
                   throws PortalException

Throws:

PortalException

deleteKBArticles

void deleteKBArticles(long groupId,
                      long[] resourcePrimKeys)
               throws PortalException

Throws:

PortalException

deleteTempAttachment

void deleteTempAttachment(long groupId,
                          long resourcePrimKey,
                          java.lang.String fileName,
                          java.lang.String tempFolderName)
                   throws PortalException

Throws:

PortalException

fetchFirstChildKBArticle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBArticle fetchFirstChildKBArticle(long groupId,
                                                                                                      long parentResourcePrimKey)

fetchFirstChildKBArticle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBArticle fetchFirstChildKBArticle(long groupId,
                                                                                                      long parentResourcePrimKey,
                                                                                                      int status)

fetchKBArticleByUrlTitle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBArticle fetchKBArticleByUrlTitle(long groupId,
                                                                                                      long kbFolderId,
                                                                                                      java.lang.String urlTitle)
                                                                                               throws PortalException

Throws:

PortalException

fetchLatestKBArticle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBArticle fetchLatestKBArticle(long resourcePrimKey,
                                                                                                  int status)
                                                                                           throws PortalException

Throws:

PortalException

fetchLatestKBArticleByUrlTitle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBArticle fetchLatestKBArticleByUrlTitle(long groupId,
                                                                                                            long kbFolderId,
                                                                                                            java.lang.String urlTitle,
                                                                                                            int status)
                                                                                                     throws PortalException

Throws:

PortalException

getAllDescendantKBArticles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<KBArticle> getAllDescendantKBArticles(long groupId,
                                                                                                                        long resourcePrimKey,
                                                                                                                        int status,
                                                                                                                        OrderByComparator<KBArticle> orderByComparator)
                                                                                                                 throws PortalException

Throws:

PortalException

getGroupKBArticles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<KBArticle> getGroupKBArticles(long groupId,
                                                                                                                int status,
                                                                                                                int start,
                                                                                                                int end,
                                                                                                                OrderByComparator<KBArticle> orderByComparator)

getGroupKBArticlesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupKBArticlesCount(long groupId,
                                                                                               int status)

getGroupKBArticlesRSS

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.lang.String getGroupKBArticlesRSS(int status,
                                                                                                          int rssDelta,
                                                                                                          java.lang.String rssDisplayStyle,
                                                                                                          java.lang.String rssFormat,
                                                                                                          ThemeDisplay themeDisplay)
                                                                                                   throws PortalException

Throws:

PortalException

getKBArticle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBArticle getKBArticle(long resourcePrimKey,
                                                                                          int version)
                                                                                   throws PortalException

Throws:

PortalException

getKBArticleAndAllDescendantKBArticles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<KBArticle> getKBArticleAndAllDescendantKBArticles(long resourcePrimKey,
                                                                                                                                    int status,
                                                                                                                                    OrderByComparator<KBArticle> orderByComparator)
                                                                                                                             throws PortalException

Throws:

PortalException

getKBArticleRSS

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.lang.String getKBArticleRSS(long resourcePrimKey,
                                                                                                    int status,
                                                                                                    int rssDelta,
                                                                                                    java.lang.String rssDisplayStyle,
                                                                                                    java.lang.String rssFormat,
                                                                                                    ThemeDisplay themeDisplay)
                                                                                             throws PortalException

Throws:

PortalException

getKBArticles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<KBArticle> getKBArticles(long groupId,
                                                                                                           long parentResourcePrimKey,
                                                                                                           int status,
                                                                                                           int start,
                                                                                                           int end,
                                                                                                           OrderByComparator<KBArticle> orderByComparator)

getKBArticles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<KBArticle> getKBArticles(long groupId,
                                                                                                           long[] resourcePrimKeys,
                                                                                                           int status,
                                                                                                           int start,
                                                                                                           int end,
                                                                                                           OrderByComparator<KBArticle> orderByComparator)

getKBArticles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<KBArticle> getKBArticles(long groupId,
                                                                                                           long[] resourcePrimKeys,
                                                                                                           int status,
                                                                                                           OrderByComparator<KBArticle> orderByComparator)

getKBArticlesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getKBArticlesCount(long groupId,
                                                                                          long parentResourcePrimKey,
                                                                                          int status)

getKBArticlesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getKBArticlesCount(long groupId,
                                                                                          long[] resourcePrimKeys,
                                                                                          int status)

getKBArticleSearchDisplay

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBArticleSearchDisplay getKBArticleSearchDisplay(long groupId,
                                                                                                                    java.lang.String title,
                                                                                                                    java.lang.String content,
                                                                                                                    int status,
                                                                                                                    java.util.Date startDate,
                                                                                                                    java.util.Date endDate,
                                                                                                                    boolean andOperator,
                                                                                                                    int[] curStartValues,
                                                                                                                    int cur,
                                                                                                                    int delta,
                                                                                                                    OrderByComparator<KBArticle> orderByComparator)
                                                                                                             throws PortalException

Throws:

PortalException

getKBArticleVersions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<KBArticle> getKBArticleVersions(long groupId,
                                                                                                                  long resourcePrimKey,
                                                                                                                  int status,
                                                                                                                  int start,
                                                                                                                  int end,
                                                                                                                  OrderByComparator<KBArticle> orderByComparator)

getKBArticleVersionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getKBArticleVersionsCount(long groupId,
                                                                                                 long resourcePrimKey,
                                                                                                 int status)

getLatestKBArticle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBArticle getLatestKBArticle(long resourcePrimKey,
                                                                                                int status)
                                                                                         throws PortalException

Throws:

PortalException

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPreviousAndNextKBArticles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBArticle[] getPreviousAndNextKBArticles(long kbArticleId)
                                                                                                     throws PortalException

Throws:

PortalException

getSectionsKBArticles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<KBArticle> getSectionsKBArticles(long groupId,
                                                                                                                   java.lang.String[] sections,
                                                                                                                   int status,
                                                                                                                   int start,
                                                                                                                   int end,
                                                                                                                   OrderByComparator<KBArticle> orderByComparator)

getSectionsKBArticlesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getSectionsKBArticlesCount(long groupId,
                                                                                                  java.lang.String[] sections,
                                                                                                  int status)

getTempAttachmentNames

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.lang.String[] getTempAttachmentNames(long groupId,
                                                                                                             java.lang.String tempFolderName)
                                                                                                      throws PortalException

Throws:

PortalException

moveKBArticle

void moveKBArticle(long resourcePrimKey,
                   long parentResourceClassNameId,
                   long parentResourcePrimKey,
                   double priority)
            throws PortalException

Throws:

PortalException

revertKBArticle

KBArticle revertKBArticle(long resourcePrimKey,
                          int version,
                          ServiceContext serviceContext)
                   throws PortalException

Throws:

PortalException

subscribeGroupKBArticles

void subscribeGroupKBArticles(long groupId,
                              java.lang.String portletId)
                       throws PortalException

Throws:

PortalException

subscribeKBArticle

void subscribeKBArticle(long groupId,
                        long resourcePrimKey)
                 throws PortalException

Throws:

PortalException

unsubscribeGroupKBArticles

void unsubscribeGroupKBArticles(long groupId,
                                java.lang.String portletId)
                         throws PortalException

Throws:

PortalException

unsubscribeKBArticle

void unsubscribeKBArticle(long resourcePrimKey)
                   throws PortalException

Throws:

PortalException

updateKBArticle

KBArticle updateKBArticle(long resourcePrimKey,
                          java.lang.String title,
                          java.lang.String content,
                          java.lang.String description,
                          java.lang.String sourceURL,
                          java.lang.String[] sections,
                          java.lang.String[] selectedFileNames,
                          long[] removeFileEntryIds,
                          ServiceContext serviceContext)
                   throws PortalException

Throws:

PortalException

updateKBArticlesPriorities

void updateKBArticlesPriorities(long groupId,
                                java.util.Map<java.lang.Long,java.lang.Double> resourcePrimKeyToPriorityMap)
                         throws PortalException

Throws:

PortalException