Class KBTemplateLocalServiceUtil
com.liferay.knowledge.base.service.impl.KBTemplateLocalServiceImpl
and
is an access point for service operations in application layer code running
on the local server. 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:
- Generated:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic KBTemplate
addKBTemplate
(long userId, String title, String content, com.liferay.portal.kernel.service.ServiceContext serviceContext) static KBTemplate
addKBTemplate
(KBTemplate kbTemplate) Adds the kb template to the database.static KBTemplate
createKBTemplate
(long kbTemplateId) Creates a new kb template with the primary key.static com.liferay.portal.kernel.model.PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static void
deleteGroupKBTemplates
(long groupId) static KBTemplate
deleteKBTemplate
(long kbTemplateId) Deletes the kb template with the primary key from the database.static KBTemplate
deleteKBTemplate
(KBTemplate kbTemplate) Deletes the kb template from the database.static void
deleteKBTemplates
(long[] kbTemplateIds) static com.liferay.portal.kernel.model.PersistedModel
deletePersistedModel
(com.liferay.portal.kernel.model.PersistedModel persistedModel) static <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static com.liferay.portal.kernel.dao.orm.DynamicQuery
static <T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <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.static <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.static long
dynamicQueryCount
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static 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.static KBTemplate
fetchKBTemplate
(long kbTemplateId) static KBTemplate
fetchKBTemplateByUuidAndGroupId
(String uuid, long groupId) Returns the kb template matching the UUID and group.static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery
getExportActionableDynamicQuery
(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) static List<KBTemplate>
getGroupKBTemplates
(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBTemplate> orderByComparator) static int
getGroupKBTemplatesCount
(long groupId) static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
static KBTemplate
getKBTemplate
(long kbTemplateId) Returns the kb template with the primary key.static KBTemplate
getKBTemplateByUuidAndGroupId
(String uuid, long groupId) Returns the kb template matching the UUID and group.static List<KBTemplate>
getKBTemplates
(int start, int end) Returns a range of all the kb templates.static List<KBTemplate>
getKBTemplatesByUuidAndCompanyId
(String uuid, long companyId) Returns all the kb templates matching the UUID and company.static 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.static int
Returns the number of kb templates.static String
Returns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static KBTemplateLocalService
static 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) static KBTemplate
updateKBTemplate
(long kbTemplateId, String title, String content, com.liferay.portal.kernel.service.ServiceContext serviceContext) static KBTemplate
updateKBTemplate
(KBTemplate kbTemplate) Updates the kb template in the database or adds it if it does not yet exist.static void
updateKBTemplateResources
(KBTemplate kbTemplate, String[] groupPermissions, String[] guestPermissions)
-
Constructor Details
-
KBTemplateLocalServiceUtil
public KBTemplateLocalServiceUtil()
-
-
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
public static 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
public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteGroupKBTemplates
public static void deleteGroupKBTemplates(long groupId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteKBTemplate
public static 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
public static 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
public static void deleteKBTemplates(long[] kbTemplateIds) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deletePersistedModel
public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
dslQuery
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dslQueryCount
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dynamicQuery
public static com.liferay.portal.kernel.dao.orm.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
public static <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 - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is 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
public static <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 - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is 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
public static 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
public static 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
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
null
if a matching kb template could not be found
-
getActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getExportActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) -
getGroupKBTemplates
public static List<KBTemplate> getGroupKBTemplates(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBTemplate> orderByComparator) -
getGroupKBTemplatesCount
public static int getGroupKBTemplatesCount(long groupId) -
getIndexableActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getKBTemplate
public static 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
public static 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
Returns a range of all the kb templates.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is 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
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
public static 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
public static int getKBTemplatesCount()Returns the number of kb templates.- Returns:
- the number of kb templates
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
search
public static 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
public static 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
public static void updateKBTemplateResources(KBTemplate kbTemplate, String[] groupPermissions, String[] guestPermissions) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getService
-