Interface KBTemplateLocalService
- All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService,com.liferay.portal.kernel.service.change.tracking.CTService<KBTemplate>,com.liferay.portal.kernel.service.PersistedModelLocalService
- All Known Implementing Classes:
KBTemplateLocalServiceWrapper
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionaddKBTemplate(long userId, String title, String content, com.liferay.portal.kernel.service.ServiceContext serviceContext) addKBTemplate(KBTemplate kbTemplate) Adds the kb template to the database.createKBTemplate(long kbTemplateId) Creates a new kb template with the primary key.com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) voiddeleteGroupKBTemplates(long groupId) deleteKBTemplate(long kbTemplateId) Deletes the kb template with the primary key from the database.deleteKBTemplate(KBTemplate kbTemplate) Deletes the kb template from the database.voiddeleteKBTemplates(long[] kbTemplateIds) com.liferay.portal.kernel.model.PersistedModeldeletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) com.liferay.portal.kernel.dao.orm.DynamicQuery<T> List<T>dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<T> 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> 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.longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.longdynamicQueryCount(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.fetchKBTemplate(long kbTemplateId) fetchKBTemplateByUuidAndGroupId(String uuid, long groupId) Returns the kb template matching the UUID and group.com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerycom.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<KBTemplate>com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuerygetExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) getGroupKBTemplates(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBTemplate> orderByComparator) intgetGroupKBTemplatesCount(long groupId) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuerygetKBTemplate(long kbTemplateId) Returns the kb template with the primary key.getKBTemplateByUuidAndGroupId(String uuid, long groupId) Returns the kb template matching the UUID and group.getKBTemplates(int start, int end) Returns a range of all the kb templates.getKBTemplatesByUuidAndCompanyId(String uuid, long companyId) Returns all the kb templates matching the UUID and company.getKBTemplatesByUuidAndCompanyId(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.intReturns the number of kb templates.Returns the OSGi service identifier.com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) search(long groupId, String title, String content, Date startDate, Date endDate, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBTemplate> orderByComparator) updateKBTemplate(long kbTemplateId, String title, String content, com.liferay.portal.kernel.service.ServiceContext serviceContext) updateKBTemplate(KBTemplate kbTemplate) Updates the kb template in the database or adds it if it does not yet exist.voidupdateKBTemplateResources(KBTemplate kbTemplate, String[] groupPermissions, String[] guestPermissions) <R,E extends Throwable>
RupdateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<KBTemplate>, R, E> updateUnsafeFunction) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addKBTemplate
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, String title, String content, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
createKBTemplate
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(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
createPersistedModelin interfacecom.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:
deletePersistedModelin interfacecom.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) - Specified by:
dslQueryin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCountin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() -
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> 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> 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.knowledge.base.model.impl.KBTemplateModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.knowledge.base.model.impl.KBTemplateModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- the upper bound of the range of model instances (not inclusive)orderByComparator- the comparator to order the results by (optionallynull)- 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 queryprojection- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchKBTemplate
-
fetchKBTemplateByUuidAndGroupId
@Transactional(propagation=SUPPORTS, readOnly=true) KBTemplate fetchKBTemplateByUuidAndGroupId(String uuid, long groupId) Returns the kb template matching the UUID and group.- Parameters:
uuid- the kb template's UUIDgroupId- the primary key of the group- Returns:
- the matching kb template, or
nullif 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) 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(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 UUIDgroupId- 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) List<KBTemplate> getKBTemplates(int start, int end) Returns a range of all the kb templates.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.knowledge.base.model.impl.KBTemplateModelImpl.- Parameters:
start- the lower bound of the range of kb templatesend- the upper bound of the range of kb templates (not inclusive)- Returns:
- the range of kb templates
-
getKBTemplatesByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) List<KBTemplate> getKBTemplatesByUuidAndCompanyId(String uuid, long companyId) Returns all the kb templates matching the UUID and company.- Parameters:
uuid- the UUID of the kb templatescompanyId- 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) List<KBTemplate> getKBTemplatesByUuidAndCompanyId(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 templatescompanyId- the primary key of the companystart- the lower bound of the range of kb templatesend- the upper bound of the range of kb templates (not inclusive)orderByComparator- the comparator to order the results by (optionallynull)- 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
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(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getPersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
search
@Transactional(propagation=SUPPORTS, readOnly=true) List<KBTemplate> search(long groupId, String title, String content, Date startDate, Date endDate, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBTemplate> orderByComparator) -
updateKBTemplate
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, String title, 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, String[] groupPermissions, String[] guestPermissions) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getCTPersistence
@Transactional(enabled=false) com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<KBTemplate> getCTPersistence()- Specified by:
getCTPersistencein interfacecom.liferay.portal.kernel.service.change.tracking.CTService<KBTemplate>
-
getModelClass
- Specified by:
getModelClassin interfacecom.liferay.portal.kernel.service.change.tracking.CTService<KBTemplate>
-
updateWithUnsafeFunction
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<KBTemplate>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunctionin interfacecom.liferay.portal.kernel.service.change.tracking.CTService<KBTemplate>- Throws:
E extends Throwable
-