com.liferay.knowledge.base.service

Interface KBTemplateLocalService

All Superinterfaces:

com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

All Known Implementing Classes:

KBTemplateLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface KBTemplateLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

Provides the local service interface for KBTemplate. 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:

KBTemplateLocalServiceUtil

Generated:

Method Summary

Modifier and Type	Method and Description
KBTemplate	addKBTemplate(KBTemplate kbTemplate) Adds the kb template to the database.
KBTemplate	addKBTemplate(long userId, java.lang.String title, java.lang.String content, com.liferay.portal.kernel.service.ServiceContext serviceContext)
KBTemplate	createKBTemplate(long kbTemplateId) Creates a new kb template with the primary key.
com.liferay.portal.kernel.model.PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
void	deleteGroupKBTemplates(long groupId)
KBTemplate	deleteKBTemplate(KBTemplate kbTemplate) Deletes the kb template from the database.
KBTemplate	deleteKBTemplate(long kbTemplateId) Deletes the kb template with the primary key from the database.
void	deleteKBTemplates(long[] kbTemplateIds)
com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
<T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.
KBTemplate	fetchKBTemplate(long kbTemplateId)
KBTemplate	fetchKBTemplateByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the kb template matching the UUID and group.
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery	getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
java.util.List<KBTemplate>	getGroupKBTemplates(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBTemplate> orderByComparator)
int	getGroupKBTemplatesCount(long groupId)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
KBTemplate	getKBTemplate(long kbTemplateId) Returns the kb template with the primary key.
KBTemplate	getKBTemplateByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the kb template matching the UUID and group.
java.util.List<KBTemplate>	getKBTemplates(int start, int end) Returns a range of all the kb templates.
java.util.List<KBTemplate>	getKBTemplatesByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns all the kb templates matching the UUID and company.
java.util.List<KBTemplate>	getKBTemplatesByUuidAndCompanyId(java.lang.String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBTemplate> orderByComparator) Returns a range of kb templates matching the UUID and company.
int	getKBTemplatesCount() Returns the number of kb templates.
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
java.util.List<KBTemplate>	search(long groupId, java.lang.String title, java.lang.String content, java.util.Date startDate, java.util.Date endDate, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBTemplate> orderByComparator)
KBTemplate	updateKBTemplate(KBTemplate kbTemplate) Updates the kb template in the database or adds it if it does not yet exist.
KBTemplate	updateKBTemplate(long kbTemplateId, java.lang.String title, java.lang.String content, com.liferay.portal.kernel.service.ServiceContext serviceContext)
void	updateKBTemplateResources(KBTemplate kbTemplate, java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)

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

getBasePersistence

Method Detail

addKBTemplate

@Indexable(type=REINDEX)
KBTemplate addKBTemplate(KBTemplate kbTemplate)

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

Important: Inspect KBTemplateLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

kbTemplate - the kb template

Returns:

the kb template that was added

addKBTemplate

KBTemplate addKBTemplate(long userId,
                         java.lang.String title,
                         java.lang.String content,
                         com.liferay.portal.kernel.service.ServiceContext serviceContext)
                  throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

createKBTemplate

@Transactional(enabled=false)
KBTemplate createKBTemplate(long kbTemplateId)

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

Parameters:

kbTemplateId - the primary key for the new kb template

Returns:

the new kb template

createPersistedModel

com.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteGroupKBTemplates

void deleteGroupKBTemplates(long groupId)
                     throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteKBTemplate

@Indexable(type=DELETE)
 @SystemEvent(action=1,
             type=1)
KBTemplate deleteKBTemplate(KBTemplate kbTemplate)
                                                                                          throws com.liferay.portal.kernel.exception.PortalException

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

Important: Inspect KBTemplateLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

kbTemplate - the kb template

Returns:

the kb template that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteKBTemplate

@Indexable(type=DELETE)
KBTemplate deleteKBTemplate(long kbTemplateId)
                                             throws com.liferay.portal.kernel.exception.PortalException

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

Important: Inspect KBTemplateLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

kbTemplateId - the primary key of the kb template

Returns:

the kb template that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException - if a kb template with the primary key could not be found

deleteKBTemplates

void deleteKBTemplates(long[] kbTemplateIds)
                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deletePersistedModel

com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

dslQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.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.KBTemplateModelImpl.

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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                                                                      int start,
                                                                                                      int end,
                                                                                                      com.liferay.portal.kernel.util.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.KBTemplateModelImpl.

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(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                                                          com.liferay.portal.kernel.dao.orm.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

fetchKBTemplate

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBTemplate fetchKBTemplate(long kbTemplateId)

fetchKBTemplateByUuidAndGroupId

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

Returns the kb template matching the UUID and group.

Parameters:

uuid - the kb template's UUID

groupId - the primary key of the group

Returns:

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

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)

getGroupKBTemplates

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<KBTemplate> getGroupKBTemplates(long groupId,
                                                                                                                  int start,
                                                                                                                  int end,
                                                                                                                  com.liferay.portal.kernel.util.OrderByComparator<KBTemplate> orderByComparator)

getGroupKBTemplatesCount

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

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getKBTemplate

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBTemplate getKBTemplate(long kbTemplateId)
                                                                                     throws com.liferay.portal.kernel.exception.PortalException

Returns the kb template with the primary key.

Parameters:

kbTemplateId - the primary key of the kb template

Returns:

the kb template

Throws:

com.liferay.portal.kernel.exception.PortalException - if a kb template with the primary key could not be found

getKBTemplateByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBTemplate getKBTemplateByUuidAndGroupId(java.lang.String uuid,
                                                                                                            long groupId)
                                                                                                     throws com.liferay.portal.kernel.exception.PortalException

Returns the kb template matching the UUID and group.

Parameters:

uuid - the kb template's UUID

groupId - the primary key of the group

Returns:

the matching kb template

Throws:

com.liferay.portal.kernel.exception.PortalException - if a matching kb template could not be found

getKBTemplates

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

Returns a range of all the kb templates.

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.KBTemplateModelImpl.

Parameters:

start - the lower bound of the range of kb templates

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

Returns:

the range of kb templates

getKBTemplatesByUuidAndCompanyId

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

Returns all the kb templates matching the UUID and company.

Parameters:

uuid - the UUID of the kb templates

companyId - the primary key of the company

Returns:

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

getKBTemplatesByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<KBTemplate> getKBTemplatesByUuidAndCompanyId(java.lang.String uuid,
                                                                                                                               long companyId,
                                                                                                                               int start,
                                                                                                                               int end,
                                                                                                                               com.liferay.portal.kernel.util.OrderByComparator<KBTemplate> orderByComparator)

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

Parameters:

uuid - the UUID of the kb templates

companyId - the primary key of the company

start - the lower bound of the range of kb templates

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

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

Returns:

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

getKBTemplatesCount

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

Returns the number of kb templates.

Returns:

the number of kb templates

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<KBTemplate> search(long groupId,
                                                                                                     java.lang.String title,
                                                                                                     java.lang.String content,
                                                                                                     java.util.Date startDate,
                                                                                                     java.util.Date endDate,
                                                                                                     boolean andOperator,
                                                                                                     int start,
                                                                                                     int end,
                                                                                                     com.liferay.portal.kernel.util.OrderByComparator<KBTemplate> orderByComparator)

updateKBTemplate

@Indexable(type=REINDEX)
KBTemplate updateKBTemplate(KBTemplate kbTemplate)

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

Important: Inspect KBTemplateLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

kbTemplate - the kb template

Returns:

the kb template that was updated

updateKBTemplate

KBTemplate updateKBTemplate(long kbTemplateId,
                            java.lang.String title,
                            java.lang.String content,
                            com.liferay.portal.kernel.service.ServiceContext serviceContext)
                     throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateKBTemplateResources

void updateKBTemplateResources(KBTemplate kbTemplate,
                               java.lang.String[] groupPermissions,
                               java.lang.String[] guestPermissions)
                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException