com.liferay.knowledge.base.service

Class KBArticleServiceUtil

java.lang.Object

com.liferay.knowledge.base.service.KBArticleServiceUtil

public class KBArticleServiceUtil
extends java.lang.Object

Provides the remote service utility for KBArticle. This utility wraps com.liferay.knowledge.base.service.impl.KBArticleServiceImpl and is an access point for service operations in application layer code running on a remote server. 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:

KBArticleService

Constructor Summary

Constructors

Constructor and Description
KBArticleServiceUtil()

Method Summary

Modifier and Type	Method and Description
static 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)
static int	addKBArticlesMarkdown(long groupId, long parentKBFolderId, java.lang.String fileName, boolean prioritizeByNumericalPrefix, java.io.InputStream inputStream, ServiceContext serviceContext)
static void	addTempAttachment(long groupId, long resourcePrimKey, java.lang.String fileName, java.lang.String tempFolderName, java.io.InputStream inputStream, java.lang.String mimeType)
static KBArticle	deleteKBArticle(long resourcePrimKey)
static void	deleteKBArticles(long groupId, long[] resourcePrimKeys)
static void	deleteTempAttachment(long groupId, long resourcePrimKey, java.lang.String fileName, java.lang.String tempFolderName)
static KBArticle	fetchFirstChildKBArticle(long groupId, long parentResourcePrimKey)
static KBArticle	fetchFirstChildKBArticle(long groupId, long parentResourcePrimKey, int status)
static KBArticle	fetchKBArticleByUrlTitle(long groupId, long kbFolderId, java.lang.String urlTitle)
static KBArticle	fetchLatestKBArticle(long resourcePrimKey, int status)
static KBArticle	fetchLatestKBArticleByUrlTitle(long groupId, long kbFolderId, java.lang.String urlTitle, int status)
static java.util.List<KBArticle>	getAllDescendantKBArticles(long groupId, long resourcePrimKey, int status, OrderByComparator<KBArticle> orderByComparator)
static java.util.List<KBArticle>	getGroupKBArticles(long groupId, int status, int start, int end, OrderByComparator<KBArticle> orderByComparator)
static int	getGroupKBArticlesCount(long groupId, int status)
static java.lang.String	getGroupKBArticlesRSS(int status, int rssDelta, java.lang.String rssDisplayStyle, java.lang.String rssFormat, ThemeDisplay themeDisplay)
static KBArticle	getKBArticle(long resourcePrimKey, int version)
static java.util.List<KBArticle>	getKBArticleAndAllDescendantKBArticles(long resourcePrimKey, int status, OrderByComparator<KBArticle> orderByComparator)
static java.lang.String	getKBArticleRSS(long resourcePrimKey, int status, int rssDelta, java.lang.String rssDisplayStyle, java.lang.String rssFormat, ThemeDisplay themeDisplay)
static java.util.List<KBArticle>	getKBArticles(long groupId, long[] resourcePrimKeys, int status, int start, int end, OrderByComparator<KBArticle> orderByComparator)
static java.util.List<KBArticle>	getKBArticles(long groupId, long[] resourcePrimKeys, int status, OrderByComparator<KBArticle> orderByComparator)
static java.util.List<KBArticle>	getKBArticles(long groupId, long parentResourcePrimKey, int status, int start, int end, OrderByComparator<KBArticle> orderByComparator)
static int	getKBArticlesCount(long groupId, long[] resourcePrimKeys, int status)
static int	getKBArticlesCount(long groupId, long parentResourcePrimKey, int status)
static 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)
static java.util.List<KBArticle>	getKBArticleVersions(long groupId, long resourcePrimKey, int status, int start, int end, OrderByComparator<KBArticle> orderByComparator)
static int	getKBArticleVersionsCount(long groupId, long resourcePrimKey, int status)
static KBArticle	getLatestKBArticle(long resourcePrimKey, int status)
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static KBArticle[]	getPreviousAndNextKBArticles(long kbArticleId)
static java.util.List<KBArticle>	getSectionsKBArticles(long groupId, java.lang.String[] sections, int status, int start, int end, OrderByComparator<KBArticle> orderByComparator)
static int	getSectionsKBArticlesCount(long groupId, java.lang.String[] sections, int status)
static KBArticleService	getService()
static java.lang.String[]	getTempAttachmentNames(long groupId, java.lang.String tempFolderName)
static void	moveKBArticle(long resourcePrimKey, long parentResourceClassNameId, long parentResourcePrimKey, double priority)
static KBArticle	revertKBArticle(long resourcePrimKey, int version, ServiceContext serviceContext)
static void	subscribeGroupKBArticles(long groupId, java.lang.String portletId)
static void	subscribeKBArticle(long groupId, long resourcePrimKey)
static void	unsubscribeGroupKBArticles(long groupId, java.lang.String portletId)
static void	unsubscribeKBArticle(long resourcePrimKey)
static 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)
static void	updateKBArticlesPriorities(long groupId, java.util.Map<java.lang.Long,java.lang.Double> resourcePrimKeyToPriorityMap)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KBArticleServiceUtil

public KBArticleServiceUtil()

Method Detail

addKBArticle

public static 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

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

Throws:

PortalException

addTempAttachment

public static 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

public static KBArticle deleteKBArticle(long resourcePrimKey)
                                 throws PortalException

Throws:

PortalException

deleteKBArticles

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

Throws:

PortalException

deleteTempAttachment

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

Throws:

PortalException

fetchFirstChildKBArticle

public static KBArticle fetchFirstChildKBArticle(long groupId,
                                                 long parentResourcePrimKey)

fetchFirstChildKBArticle

public static KBArticle fetchFirstChildKBArticle(long groupId,
                                                 long parentResourcePrimKey,
                                                 int status)

fetchKBArticleByUrlTitle

public static KBArticle fetchKBArticleByUrlTitle(long groupId,
                                                 long kbFolderId,
                                                 java.lang.String urlTitle)
                                          throws PortalException

Throws:

PortalException

fetchLatestKBArticle

public static KBArticle fetchLatestKBArticle(long resourcePrimKey,
                                             int status)
                                      throws PortalException

Throws:

PortalException

fetchLatestKBArticleByUrlTitle

public static KBArticle fetchLatestKBArticleByUrlTitle(long groupId,
                                                       long kbFolderId,
                                                       java.lang.String urlTitle,
                                                       int status)
                                                throws PortalException

Throws:

PortalException

getAllDescendantKBArticles

public static java.util.List<KBArticle> getAllDescendantKBArticles(long groupId,
                                                                   long resourcePrimKey,
                                                                   int status,
                                                                   OrderByComparator<KBArticle> orderByComparator)
                                                            throws PortalException

Throws:

PortalException

getGroupKBArticles

public static java.util.List<KBArticle> getGroupKBArticles(long groupId,
                                                           int status,
                                                           int start,
                                                           int end,
                                                           OrderByComparator<KBArticle> orderByComparator)

getGroupKBArticlesCount

public static int getGroupKBArticlesCount(long groupId,
                                          int status)

getGroupKBArticlesRSS

public static java.lang.String getGroupKBArticlesRSS(int status,
                                                     int rssDelta,
                                                     java.lang.String rssDisplayStyle,
                                                     java.lang.String rssFormat,
                                                     ThemeDisplay themeDisplay)
                                              throws PortalException

Throws:

PortalException

getKBArticle

public static KBArticle getKBArticle(long resourcePrimKey,
                                     int version)
                              throws PortalException

Throws:

PortalException

getKBArticleAndAllDescendantKBArticles

public static java.util.List<KBArticle> getKBArticleAndAllDescendantKBArticles(long resourcePrimKey,
                                                                               int status,
                                                                               OrderByComparator<KBArticle> orderByComparator)
                                                                        throws PortalException

Throws:

PortalException

getKBArticleRSS

public static 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

public static java.util.List<KBArticle> getKBArticles(long groupId,
                                                      long parentResourcePrimKey,
                                                      int status,
                                                      int start,
                                                      int end,
                                                      OrderByComparator<KBArticle> orderByComparator)

getKBArticles

public static java.util.List<KBArticle> getKBArticles(long groupId,
                                                      long[] resourcePrimKeys,
                                                      int status,
                                                      int start,
                                                      int end,
                                                      OrderByComparator<KBArticle> orderByComparator)

getKBArticles

public static java.util.List<KBArticle> getKBArticles(long groupId,
                                                      long[] resourcePrimKeys,
                                                      int status,
                                                      OrderByComparator<KBArticle> orderByComparator)

getKBArticlesCount

public static int getKBArticlesCount(long groupId,
                                     long parentResourcePrimKey,
                                     int status)

getKBArticlesCount

public static int getKBArticlesCount(long groupId,
                                     long[] resourcePrimKeys,
                                     int status)

getKBArticleSearchDisplay

public static 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

public static java.util.List<KBArticle> getKBArticleVersions(long groupId,
                                                             long resourcePrimKey,
                                                             int status,
                                                             int start,
                                                             int end,
                                                             OrderByComparator<KBArticle> orderByComparator)

getKBArticleVersionsCount

public static int getKBArticleVersionsCount(long groupId,
                                            long resourcePrimKey,
                                            int status)

getLatestKBArticle

public static KBArticle getLatestKBArticle(long resourcePrimKey,
                                           int status)
                                    throws PortalException

Throws:

PortalException

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPreviousAndNextKBArticles

public static KBArticle[] getPreviousAndNextKBArticles(long kbArticleId)
                                                throws PortalException

Throws:

PortalException

getSectionsKBArticles

public static java.util.List<KBArticle> getSectionsKBArticles(long groupId,
                                                              java.lang.String[] sections,
                                                              int status,
                                                              int start,
                                                              int end,
                                                              OrderByComparator<KBArticle> orderByComparator)

getSectionsKBArticlesCount

public static int getSectionsKBArticlesCount(long groupId,
                                             java.lang.String[] sections,
                                             int status)

getTempAttachmentNames

public static java.lang.String[] getTempAttachmentNames(long groupId,
                                                        java.lang.String tempFolderName)
                                                 throws PortalException

Throws:

PortalException

moveKBArticle

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

Throws:

PortalException

revertKBArticle

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

Throws:

PortalException

subscribeGroupKBArticles

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

Throws:

PortalException

subscribeKBArticle

public static void subscribeKBArticle(long groupId,
                                      long resourcePrimKey)
                               throws PortalException

Throws:

PortalException

unsubscribeGroupKBArticles

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

Throws:

PortalException

unsubscribeKBArticle

public static void unsubscribeKBArticle(long resourcePrimKey)
                                 throws PortalException

Throws:

PortalException

updateKBArticle

public static 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

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

Throws:

PortalException

getService

public static KBArticleService getService()