com.liferay.knowledge.base.service

Interface KBFolderLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

KBFolderLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface KBFolderLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for KBFolder. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:

KBFolderLocalServiceUtil

Method Summary

Modifier and Type	Method and Description
KBFolder	addKBFolder(KBFolder kbFolder) Adds the kb folder to the database.
KBFolder	addKBFolder(long userId, long groupId, long parentResourceClassNameId, long parentResourcePrimKey, java.lang.String name, java.lang.String description, ServiceContext serviceContext)
KBFolder	createKBFolder(long kbFolderId) Creates a new kb folder with the primary key.
PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
KBFolder	deleteKBFolder(KBFolder kbFolder) Deletes the kb folder from the database.
KBFolder	deleteKBFolder(long kbFolderId) Deletes the kb folder with the primary key from the database.
void	deleteKBFolders(long groupId)
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
<T> T	dslQuery(DSLQuery dslQuery)
DynamicQuery	dynamicQuery()
<T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
KBFolder	fetchFirstChildKBFolder(long groupId, long kbFolderId)
KBFolder	fetchFirstChildKBFolder(long groupId, long kbFolderId, OrderByComparator<KBFolder> orderByComparator)
KBFolder	fetchKBFolder(long kbFolderId)
KBFolder	fetchKBFolder(java.lang.String uuid, long groupId)
KBFolder	fetchKBFolderByUrlTitle(long groupId, long parentKbFolderId, java.lang.String urlTitle)
KBFolder	fetchKBFolderByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the kb folder matching the UUID and group.
ActionableDynamicQuery	getActionableDynamicQuery()
ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
KBFolder	getKBFolder(long kbFolderId) Returns the kb folder with the primary key.
KBFolder	getKBFolderByUrlTitle(long groupId, long parentKbFolderId, java.lang.String urlTitle)
KBFolder	getKBFolderByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the kb folder matching the UUID and group.
java.util.List<KBFolder>	getKBFolders(int start, int end) Returns a range of all the kb folders.
java.util.List<KBFolder>	getKBFolders(long groupId, long parentKBFolderId, int start, int end)
java.util.List<java.lang.Object>	getKBFoldersAndKBArticles(long groupId, long parentResourcePrimKey, int status, int start, int end, OrderByComparator<?> orderByComparator)
int	getKBFoldersAndKBArticlesCount(long groupId, long parentResourcePrimKey, int status)
java.util.List<KBFolder>	getKBFoldersByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns all the kb folders matching the UUID and company.
java.util.List<KBFolder>	getKBFoldersByUuidAndCompanyId(java.lang.String uuid, long companyId, int start, int end, OrderByComparator<KBFolder> orderByComparator) Returns a range of kb folders matching the UUID and company.
int	getKBFoldersCount() Returns the number of kb folders.
int	getKBFoldersCount(long groupId, long parentKBFolderId)
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
void	moveKBFolder(long kbFolderId, long parentKBFolderId)
KBFolder	updateKBFolder(KBFolder kbFolder) Updates the kb folder in the database or adds it if it does not yet exist.
KBFolder	updateKBFolder(long parentResourceClassNameId, long parentResourcePrimKey, long kbFolderId, java.lang.String name, java.lang.String description, ServiceContext serviceContext)

Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService

getBasePersistence

Method Detail

addKBFolder

@Indexable(type=REINDEX)
KBFolder addKBFolder(KBFolder kbFolder)

Adds the kb folder to the database. Also notifies the appropriate model listeners.

Parameters:

kbFolder - the kb folder

Returns:

the kb folder that was added

addKBFolder

KBFolder addKBFolder(long userId,
                     long groupId,
                     long parentResourceClassNameId,
                     long parentResourcePrimKey,
                     java.lang.String name,
                     java.lang.String description,
                     ServiceContext serviceContext)
              throws PortalException

Throws:

PortalException

createKBFolder

@Transactional(enabled=false)
KBFolder createKBFolder(long kbFolderId)

Creates a new kb folder with the primary key. Does not add the kb folder to the database.

Parameters:

kbFolderId - the primary key for the new kb folder

Returns:

the new kb folder

createPersistedModel

PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                             throws PortalException

Specified by:

createPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteKBFolder

@Indexable(type=DELETE)
KBFolder deleteKBFolder(KBFolder kbFolder)

Deletes the kb folder from the database. Also notifies the appropriate model listeners.

Parameters:

kbFolder - the kb folder

Returns:

the kb folder that was removed

deleteKBFolder

@Indexable(type=DELETE)
KBFolder deleteKBFolder(long kbFolderId)
                                         throws PortalException

Deletes the kb folder with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

kbFolderId - the primary key of the kb folder

Returns:

the kb folder that was removed

Throws:

PortalException - if a kb folder with the primary key could not be found

deleteKBFolders

void deleteKBFolders(long groupId)
              throws PortalException

Throws:

PortalException

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

dslQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> T dslQuery(DSLQuery dslQuery)

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                                      int start,
                                                                                                      int end)

Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.knowledge.base.model.impl.KBFolderModelImpl.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                                      int start,
                                                                                                      int end,
                                                                                                      OrderByComparator<T> orderByComparator)

Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.knowledge.base.model.impl.KBFolderModelImpl.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery,
                                                                                          Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchFirstChildKBFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBFolder fetchFirstChildKBFolder(long groupId,
                                                                                                    long kbFolderId)
                                                                                             throws PortalException

Throws:

PortalException

fetchFirstChildKBFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBFolder fetchFirstChildKBFolder(long groupId,
                                                                                                    long kbFolderId,
                                                                                                    OrderByComparator<KBFolder> orderByComparator)
                                                                                             throws PortalException

Throws:

PortalException

fetchKBFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBFolder fetchKBFolder(long kbFolderId)

fetchKBFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBFolder fetchKBFolder(java.lang.String uuid,
                                                                                          long groupId)

fetchKBFolderByUrlTitle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBFolder fetchKBFolderByUrlTitle(long groupId,
                                                                                                    long parentKbFolderId,
                                                                                                    java.lang.String urlTitle)
                                                                                             throws PortalException

Throws:

PortalException

fetchKBFolderByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBFolder fetchKBFolderByUuidAndGroupId(java.lang.String uuid,
                                                                                                          long groupId)

Returns the kb folder matching the UUID and group.

Parameters:

uuid - the kb folder's UUID

groupId - the primary key of the group

Returns:

the matching kb folder, or null if a matching kb folder could not be found

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getKBFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBFolder getKBFolder(long kbFolderId)
                                                                                 throws PortalException

Returns the kb folder with the primary key.

Parameters:

kbFolderId - the primary key of the kb folder

Returns:

the kb folder

Throws:

PortalException - if a kb folder with the primary key could not be found

getKBFolderByUrlTitle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBFolder getKBFolderByUrlTitle(long groupId,
                                                                                                  long parentKbFolderId,
                                                                                                  java.lang.String urlTitle)
                                                                                           throws PortalException

Throws:

PortalException

getKBFolderByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBFolder getKBFolderByUuidAndGroupId(java.lang.String uuid,
                                                                                                        long groupId)
                                                                                                 throws PortalException

Returns the kb folder matching the UUID and group.

Parameters:

uuid - the kb folder's UUID

groupId - the primary key of the group

Returns:

the matching kb folder

Throws:

PortalException - if a matching kb folder could not be found

getKBFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<KBFolder> getKBFolders(int start,
                                                                                                         int end)

Returns a range of all the kb folders.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.knowledge.base.model.impl.KBFolderModelImpl.

Parameters:

start - the lower bound of the range of kb folders

end - the upper bound of the range of kb folders (not inclusive)

Returns:

the range of kb folders

getKBFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<KBFolder> getKBFolders(long groupId,
                                                                                                         long parentKBFolderId,
                                                                                                         int start,
                                                                                                         int end)
                                                                                                  throws PortalException

Throws:

PortalException

getKBFoldersAndKBArticles

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

getKBFoldersAndKBArticlesCount

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

getKBFoldersByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<KBFolder> getKBFoldersByUuidAndCompanyId(java.lang.String uuid,
                                                                                                                           long companyId)

Returns all the kb folders matching the UUID and company.

Parameters:

uuid - the UUID of the kb folders

companyId - the primary key of the company

Returns:

the matching kb folders, or an empty list if no matches were found

getKBFoldersByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<KBFolder> getKBFoldersByUuidAndCompanyId(java.lang.String uuid,
                                                                                                                           long companyId,
                                                                                                                           int start,
                                                                                                                           int end,
                                                                                                                           OrderByComparator<KBFolder> orderByComparator)

Returns a range of kb folders matching the UUID and company.

Parameters:

uuid - the UUID of the kb folders

companyId - the primary key of the company

start - the lower bound of the range of kb folders

end - the upper bound of the range of kb folders (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the range of matching kb folders, or an empty list if no matches were found

getKBFoldersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getKBFoldersCount()

Returns the number of kb folders.

Returns:

the number of kb folders

getKBFoldersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getKBFoldersCount(long groupId,
                                                                                         long parentKBFolderId)
                                                                                  throws PortalException

Throws:

PortalException

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

moveKBFolder

void moveKBFolder(long kbFolderId,
                  long parentKBFolderId)
           throws PortalException

Throws:

PortalException

updateKBFolder

@Indexable(type=REINDEX)
KBFolder updateKBFolder(KBFolder kbFolder)

Updates the kb folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

kbFolder - the kb folder

Returns:

the kb folder that was updated

updateKBFolder

KBFolder updateKBFolder(long parentResourceClassNameId,
                        long parentResourcePrimKey,
                        long kbFolderId,
                        java.lang.String name,
                        java.lang.String description,
                        ServiceContext serviceContext)
                 throws PortalException

Throws:

PortalException