com.liferay.knowledge.base.service

Class KBTemplateLocalServiceUtil

java.lang.Object

com.liferay.knowledge.base.service.KBTemplateLocalServiceUtil

public class KBTemplateLocalServiceUtil
extends java.lang.Object

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

KBTemplateLocalService

Constructor Summary

Constructors

Constructor and Description
KBTemplateLocalServiceUtil()

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KBTemplateLocalServiceUtil

public KBTemplateLocalServiceUtil()

Method Detail

addKBTemplate

public static 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

public static KBTemplate addKBTemplate(long userId,
                                       java.lang.String title,
                                       java.lang.String content,
                                       ServiceContext serviceContext)
                                throws PortalException

Throws:

PortalException

createKBTemplate

public static 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

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

Throws:

PortalException

deleteGroupKBTemplates

public static void deleteGroupKBTemplates(long groupId)
                                   throws PortalException

Throws:

PortalException

deleteKBTemplate

public static KBTemplate deleteKBTemplate(KBTemplate kbTemplate)
                                   throws 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:

PortalException

deleteKBTemplate

public static KBTemplate deleteKBTemplate(long kbTemplateId)
                                   throws 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:

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

deleteKBTemplates

public static void deleteKBTemplates(long[] kbTemplateIds)
                              throws PortalException

Throws:

PortalException

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

dslQuery

public static <T> T dslQuery(DSLQuery dslQuery)

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <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

public static <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.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

public static <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.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

public static 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

public static 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

fetchKBTemplate

public static KBTemplate fetchKBTemplate(long kbTemplateId)

fetchKBTemplateByUuidAndGroupId

public static 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

public static ActionableDynamicQuery getActionableDynamicQuery()

getExportActionableDynamicQuery

public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getGroupKBTemplates

public static java.util.List<KBTemplate> getGroupKBTemplates(long groupId,
                                                             int start,
                                                             int end,
                                                             OrderByComparator<KBTemplate> orderByComparator)

getGroupKBTemplatesCount

public static int getGroupKBTemplatesCount(long groupId)

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getKBTemplate

public static KBTemplate getKBTemplate(long kbTemplateId)
                                throws PortalException

Returns the kb template with the primary key.

Parameters:

kbTemplateId - the primary key of the kb template

Returns:

the kb template

Throws:

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

getKBTemplateByUuidAndGroupId

public static KBTemplate getKBTemplateByUuidAndGroupId(java.lang.String uuid,
                                                       long groupId)
                                                throws 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:

PortalException - if a matching kb template could not be found

getKBTemplates

public static 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

public static 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

public static java.util.List<KBTemplate> getKBTemplatesByUuidAndCompanyId(java.lang.String uuid,
                                                                          long companyId,
                                                                          int start,
                                                                          int end,
                                                                          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

public static int getKBTemplatesCount()

Returns the number of kb templates.

Returns:

the number of kb templates

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

search

public static 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,
                                                OrderByComparator<KBTemplate> orderByComparator)

updateKBTemplate

public static 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

public static KBTemplate updateKBTemplate(long kbTemplateId,
                                          java.lang.String title,
                                          java.lang.String content,
                                          ServiceContext serviceContext)
                                   throws PortalException

Throws:

PortalException

updateKBTemplateResources

public static void updateKBTemplateResources(KBTemplate kbTemplate,
                                             java.lang.String[] groupPermissions,
                                             java.lang.String[] guestPermissions)
                                      throws PortalException

Throws:

PortalException

getService

public static KBTemplateLocalService getService()