Class KBArticleServiceUtil
java.lang.Object
com.liferay.knowledge.base.service.KBArticleServiceUtil
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:
- Generated:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic KBArticle
addKBArticle
(String externalReferenceCode, String portletId, long parentResourceClassNameId, long parentResourcePrimKey, String title, String urlTitle, String content, String description, String[] sections, String sourceURL, Date displayDate, Date expirationDate, Date reviewDate, String[] selectedFileNames, com.liferay.portal.kernel.service.ServiceContext serviceContext) static int
addKBArticlesMarkdown
(long groupId, long parentKBFolderId, String fileName, boolean prioritizeByNumericalPrefix, InputStream inputStream, com.liferay.portal.kernel.service.ServiceContext serviceContext) static void
addTempAttachment
(long groupId, long resourcePrimKey, String fileName, String tempFolderName, InputStream inputStream, String mimeType) static int
countKBArticlesByKeywords
(long groupId, String keywords, int status) static KBArticle
deleteKBArticle
(long resourcePrimKey) static void
deleteKBArticles
(long groupId, long[] resourcePrimKeys) static void
deleteTempAttachment
(long groupId, long resourcePrimKey, String fileName, String tempFolderName) static KBArticle
expireKBArticle
(long resourcePrimKey, com.liferay.portal.kernel.service.ServiceContext serviceContext) static KBArticle
fetchFirstChildKBArticle
(long groupId, long parentResourcePrimKey) static KBArticle
fetchFirstChildKBArticle
(long groupId, long parentResourcePrimKey, int status) static KBArticle
fetchKBArticleByUrlTitle
(long groupId, long kbFolderId, String urlTitle) static KBArticle
fetchLatestKBArticle
(long resourcePrimKey, int status) static KBArticle
fetchLatestKBArticleByExternalReferenceCode
(long groupId, String externalReferenceCode) static KBArticle
fetchLatestKBArticleByUrlTitle
(long groupId, long kbFolderId, String urlTitle, int status) static com.liferay.portal.kernel.lock.Lock
forceLockKBArticle
(long groupId, long resourcePrimKey) getAllDescendantKBArticles
(long groupId, long resourcePrimKey, int status, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) getGroupKBArticles
(long groupId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) static int
getGroupKBArticlesCount
(long groupId, int status) static String
getGroupKBArticlesRSS
(int status, int max, String type, double version, String displayStyle, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) static KBArticle
getKBArticle
(long resourcePrimKey, int version) getKBArticleAndAllDescendantKBArticles
(long resourcePrimKey, int status, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) static String
getKBArticleRSS
(long resourcePrimKey, int status, int max, String type, double version, String displayStyle, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) getKBArticles
(long groupId, long[] resourcePrimKeys, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) getKBArticles
(long groupId, long[] resourcePrimKeys, int status, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) getKBArticles
(long groupId, long parentResourcePrimKey, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) getKBArticlesByKeywords
(long groupId, String keywords, int status, int start, int end) static int
getKBArticlesCount
(long groupId, long[] resourcePrimKeys, int status) static int
getKBArticlesCount
(long groupId, long parentResourcePrimKey, int status) static KBArticleSearchDisplay
getKBArticleSearchDisplay
(long groupId, String title, String content, int status, Date startDate, Date endDate, boolean andOperator, int[] curStartValues, int cur, int delta, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) getKBArticleVersions
(long groupId, long resourcePrimKey, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) static int
getKBArticleVersionsCount
(long groupId, long resourcePrimKey, int status) static KBArticle
getLatestKBArticle
(long resourcePrimKey) static KBArticle
getLatestKBArticle
(long resourcePrimKey, int status) static KBArticle
getLatestKBArticleByExternalReferenceCode
(long groupId, String externalReferenceCode) static String
Returns the OSGi service identifier.static KBArticle[]
getPreviousAndNextKBArticles
(long kbArticleId) getSectionsKBArticles
(long groupId, String[] sections, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) static int
getSectionsKBArticlesCount
(long groupId, String[] sections, int status) static KBArticleService
static String[]
getTempAttachmentNames
(long groupId, String tempFolderName) static com.liferay.portal.kernel.lock.Lock
lockKBArticle
(long resourcePrimKey) static void
moveKBArticle
(long resourcePrimKey, long parentResourceClassNameId, long parentResourcePrimKey, double priority) static KBArticle
moveKBArticleToTrash
(long resourcePrimKey) static KBArticle
revertKBArticle
(long resourcePrimKey, int version, com.liferay.portal.kernel.service.ServiceContext serviceContext) static void
subscribeGroupKBArticles
(long groupId, String portletId) static void
subscribeKBArticle
(long groupId, long resourcePrimKey) static void
unlockKBArticle
(long resourcePrimKey) static void
unsubscribeGroupKBArticles
(long groupId, String portletId) static void
unsubscribeKBArticle
(long resourcePrimKey) static KBArticle
updateAndUnlockKBArticle
(long resourcePrimKey, String title, String content, String description, String[] sections, String sourceURL, Date displayDate, Date expirationDate, Date reviewDate, String[] selectedFileNames, long[] removeFileEntryIds, com.liferay.portal.kernel.service.ServiceContext serviceContext) static KBArticle
updateKBArticle
(long resourcePrimKey, String title, String content, String description, String[] sections, String sourceURL, Date displayDate, Date expirationDate, Date reviewDate, String[] selectedFileNames, long[] removeFileEntryIds, com.liferay.portal.kernel.service.ServiceContext serviceContext) static void
updateKBArticlesPriorities
(long groupId, Map<Long, Double> resourcePrimKeyToPriorityMap)
-
Constructor Details
-
KBArticleServiceUtil
public KBArticleServiceUtil()
-
-
Method Details
-
addKBArticle
public static KBArticle addKBArticle(String externalReferenceCode, String portletId, long parentResourceClassNameId, long parentResourcePrimKey, String title, String urlTitle, String content, String description, String[] sections, String sourceURL, Date displayDate, Date expirationDate, Date reviewDate, String[] selectedFileNames, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addKBArticlesMarkdown
public static int addKBArticlesMarkdown(long groupId, long parentKBFolderId, String fileName, boolean prioritizeByNumericalPrefix, InputStream inputStream, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addTempAttachment
public static void addTempAttachment(long groupId, long resourcePrimKey, String fileName, String tempFolderName, InputStream inputStream, String mimeType) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
countKBArticlesByKeywords
-
deleteKBArticle
public static KBArticle deleteKBArticle(long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteKBArticles
public static void deleteKBArticles(long groupId, long[] resourcePrimKeys) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteTempAttachment
public static void deleteTempAttachment(long groupId, long resourcePrimKey, String fileName, String tempFolderName) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
expireKBArticle
public static KBArticle expireKBArticle(long resourcePrimKey, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
fetchFirstChildKBArticle
-
fetchFirstChildKBArticle
public static KBArticle fetchFirstChildKBArticle(long groupId, long parentResourcePrimKey, int status) -
fetchKBArticleByUrlTitle
public static KBArticle fetchKBArticleByUrlTitle(long groupId, long kbFolderId, String urlTitle) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
fetchLatestKBArticle
public static KBArticle fetchLatestKBArticle(long resourcePrimKey, int status) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
fetchLatestKBArticleByExternalReferenceCode
public static KBArticle fetchLatestKBArticleByExternalReferenceCode(long groupId, String externalReferenceCode) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
fetchLatestKBArticleByUrlTitle
public static KBArticle fetchLatestKBArticleByUrlTitle(long groupId, long kbFolderId, String urlTitle, int status) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
forceLockKBArticle
public static com.liferay.portal.kernel.lock.Lock forceLockKBArticle(long groupId, long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getAllDescendantKBArticles
public static List<KBArticle> getAllDescendantKBArticles(long groupId, long resourcePrimKey, int status, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getGroupKBArticles
-
getGroupKBArticlesCount
public static int getGroupKBArticlesCount(long groupId, int status) -
getGroupKBArticlesRSS
public static String getGroupKBArticlesRSS(int status, int max, String type, double version, String displayStyle, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getKBArticle
public static KBArticle getKBArticle(long resourcePrimKey, int version) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getKBArticleAndAllDescendantKBArticles
public static List<KBArticle> getKBArticleAndAllDescendantKBArticles(long resourcePrimKey, int status, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getKBArticleRSS
public static String getKBArticleRSS(long resourcePrimKey, int status, int max, String type, double version, String displayStyle, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getKBArticles
-
getKBArticles
-
getKBArticles
-
getKBArticlesByKeywords
-
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, String title, String content, int status, Date startDate, Date endDate, boolean andOperator, int[] curStartValues, int cur, int delta, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getKBArticleVersions
-
getKBArticleVersionsCount
public static int getKBArticleVersionsCount(long groupId, long resourcePrimKey, int status) -
getLatestKBArticle
public static KBArticle getLatestKBArticle(long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getLatestKBArticle
public static KBArticle getLatestKBArticle(long resourcePrimKey, int status) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getLatestKBArticleByExternalReferenceCode
public static KBArticle getLatestKBArticleByExternalReferenceCode(long groupId, String externalReferenceCode) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPreviousAndNextKBArticles
public static KBArticle[] getPreviousAndNextKBArticles(long kbArticleId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getSectionsKBArticles
-
getSectionsKBArticlesCount
-
getTempAttachmentNames
public static String[] getTempAttachmentNames(long groupId, String tempFolderName) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
lockKBArticle
public static com.liferay.portal.kernel.lock.Lock lockKBArticle(long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
moveKBArticle
public static void moveKBArticle(long resourcePrimKey, long parentResourceClassNameId, long parentResourcePrimKey, double priority) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
moveKBArticleToTrash
public static KBArticle moveKBArticleToTrash(long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
revertKBArticle
public static KBArticle revertKBArticle(long resourcePrimKey, int version, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
subscribeGroupKBArticles
public static void subscribeGroupKBArticles(long groupId, String portletId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
subscribeKBArticle
public static void subscribeKBArticle(long groupId, long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
unlockKBArticle
public static void unlockKBArticle(long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
unsubscribeGroupKBArticles
public static void unsubscribeGroupKBArticles(long groupId, String portletId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
unsubscribeKBArticle
public static void unsubscribeKBArticle(long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateAndUnlockKBArticle
public static KBArticle updateAndUnlockKBArticle(long resourcePrimKey, String title, String content, String description, String[] sections, String sourceURL, Date displayDate, Date expirationDate, Date reviewDate, String[] selectedFileNames, long[] removeFileEntryIds, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateKBArticle
public static KBArticle updateKBArticle(long resourcePrimKey, String title, String content, String description, String[] sections, String sourceURL, Date displayDate, Date expirationDate, Date reviewDate, String[] selectedFileNames, long[] removeFileEntryIds, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateKBArticlesPriorities
public static void updateKBArticlesPriorities(long groupId, Map<Long, Double> resourcePrimKeyToPriorityMap) throws com.liferay.portal.kernel.exception.PortalException- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getService
-