Class DDMTemplateLocalServiceWrapper
- All Implemented Interfaces:
DDMTemplateLocalService
,com.liferay.portal.kernel.service.BaseLocalService
,com.liferay.portal.kernel.service.change.tracking.CTService<DDMTemplate>
,com.liferay.portal.kernel.service.PersistedModelLocalService
,com.liferay.portal.kernel.service.ServiceWrapper<DDMTemplateLocalService>
DDMTemplateLocalService
.- See Also:
- Generated:
-
Constructor Summary
ConstructorsConstructorDescriptionDDMTemplateLocalServiceWrapper
(DDMTemplateLocalService ddmTemplateLocalService) -
Method Summary
Modifier and TypeMethodDescriptionaddDDMTemplate
(DDMTemplate ddmTemplate) Adds the ddm template to the database.addTemplate
(String externalReferenceCode, long userId, long groupId, long classNameId, long classPK, long resourceClassNameId, String templateKey, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, String type, String mode, String language, String script, boolean cacheable, boolean smallImage, String smallImageURL, File smallImageFile, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds a template with additional parameters.addTemplate
(String externalReferenceCode, long userId, long groupId, long classNameId, long classPK, long resourceClassNameId, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, String type, String mode, String language, String script, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds a template.void
addTemplateResources
(DDMTemplate template, boolean addGroupPermissions, boolean addGuestPermissions) Adds the resources to the template.void
addTemplateResources
(DDMTemplate template, com.liferay.portal.kernel.service.permission.ModelPermissions modelPermissions) Adds the model resources with the permissions to the template.copyTemplate
(long userId, long sourceTemplateId, com.liferay.portal.kernel.service.ServiceContext serviceContext) copyTemplate
(long userId, long sourceTemplateId, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) Copies the template, creating a new template with all the values extracted from the original one.copyTemplates
(long userId, long classNameId, long sourceClassPK, long targetClassPK, String type, com.liferay.portal.kernel.service.ServiceContext serviceContext) Copies all the templates matching the class name ID, class PK, and type.createDDMTemplate
(long templateId) Creates a new ddm template with the primary key.com.liferay.portal.kernel.model.PersistedModel
createPersistedModel
(Serializable primaryKeyObj) deleteDDMTemplate
(long templateId) Deletes the ddm template with the primary key from the database.deleteDDMTemplate
(DDMTemplate ddmTemplate) Deletes the ddm template from the database.com.liferay.portal.kernel.model.PersistedModel
deletePersistedModel
(com.liferay.portal.kernel.model.PersistedModel persistedModel) void
deleteTemplate
(long templateId) Deletes the template and its resources.deleteTemplate
(DDMTemplate template) Deletes the template and its resources.deleteTemplate
(String externalReferenceCode, long groupId) void
deleteTemplates
(long groupId) Deletes all the templates of the group.void
deleteTemplates
(long groupId, long classNameId) <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(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.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.fetchDDMTemplate
(long templateId) fetchDDMTemplateByExternalReferenceCode
(String externalReferenceCode, long groupId) fetchDDMTemplateByExternalReferenceCode
(String externalReferenceCode, long groupId, boolean includeAncestorTemplates) fetchDDMTemplateByUuidAndGroupId
(String uuid, long groupId) Returns the ddm template matching the UUID and group.fetchTemplate
(long templateId) Returns the template with the primary key.fetchTemplate
(long groupId, long classNameId, String templateKey) Returns the template matching the group and template key.fetchTemplate
(long groupId, long classNameId, String templateKey, boolean includeAncestorTemplates) Returns the template matching the group and template key, optionally searching ancestor sites (that have sharing enabled) and global scoped sites.com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
com.liferay.portal.kernel.service.persistence.BasePersistence<?>
com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<DDMTemplate>
getDDMTemplate
(long templateId) Returns the ddm template with the primary key.getDDMTemplateByExternalReferenceCode
(String externalReferenceCode, long groupId) getDDMTemplateByUuidAndGroupId
(String uuid, long groupId) Returns the ddm template matching the UUID and group.getDDMTemplates
(int start, int end) Returns a range of all the ddm templates.getDDMTemplatesByUuidAndCompanyId
(String uuid, long companyId) Returns all the ddm templates matching the UUID and company.getDDMTemplatesByUuidAndCompanyId
(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMTemplate> orderByComparator) Returns a range of ddm templates matching the UUID and company.int
Returns the number of ddm templates.com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery
getExportActionableDynamicQuery
(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
Returns the OSGi service identifier.com.liferay.portal.kernel.model.PersistedModel
getPersistedModel
(Serializable primaryKeyObj) getTemplate
(long templateId) Returns the template with the primary key.getTemplate
(long groupId, long classNameId, String templateKey) Returns the template matching the group and template key.getTemplate
(long groupId, long classNameId, String templateKey, boolean includeAncestorTemplates) Returns the template matching the group and template key, optionally searching ancestor sites (that have sharing enabled) and global scoped sites.getTemplateBySmallImageId
(long smallImageId) getTemplates
(long classPK) Returns all the templates with the class PK.getTemplates
(long[] groupIds, long classNameId, long classPK) getTemplates
(long groupId, long classNameId) Returns all the templates matching the group and class name ID.getTemplates
(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, long resourceClassNameId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMTemplate> orderByComparator) getTemplates
(long groupId, long classNameId, long classPK) Returns all the templates matching the group, class name ID, and class PK.getTemplates
(long groupId, long classNameId, long classPK, boolean includeAncestorTemplates) getTemplates
(long groupId, long classNameId, long classPK, String type) Returns all the templates matching the group, class name ID, class PK, and type.getTemplates
(long groupId, long classNameId, long classPK, String type, String mode) Returns all the templates matching the group, class name ID, class PK, type, and mode.getTemplatesByClassPK
(long[] groupIds, long classPK) getTemplatesByClassPK
(long groupId, long classPK) getTemplatesByClassPK
(long groupId, long classPK, int start, int end) int
getTemplatesByClassPKCount
(long groupId, long classPK) Returns the number of templates matching the group and class PK.getTemplatesByGroupId
(long groupId) getTemplatesByStructureClassNameId
(long groupId, long structureClassNameId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMTemplate> orderByComparator) Returns an ordered range of all the templates matching the group, structure class name ID, and status.int
getTemplatesByStructureClassNameIdCount
(long groupId, long structureClassNameId, int status) Returns the number of templates matching the group, structure class name ID, and status, including Generic Templates.int
getTemplatesCount
(long groupId) Returns the number of templates belonging to the group.int
getTemplatesCount
(long[] groupIds, long classNameId, long classPK) Returns the number of templates matching the group IDs, class name ID, and class PK.int
getTemplatesCount
(long groupId, long classNameId) Returns the number of templates matching the group and class name ID.int
getTemplatesCount
(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, long resourceClassNameId) int
getTemplatesCount
(long groupId, long classNameId, long classPK) Returns the number of templates matching the group, class name ID, and class PK.void
revertTemplate
(long userId, long templateId, String version, com.liferay.portal.kernel.service.ServiceContext serviceContext) search
(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, long resourceClassNameId, String keywords, String type, String mode, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMTemplate> orderByComparator) Returns an ordered range of all the templates matching the group IDs, class Name IDs, class PK, type, mode, and status, and include the keywords on its names and descriptions.search
(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, long resourceClassNameId, String name, String description, String type, String mode, String language, int status, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMTemplate> orderByComparator) Returns an ordered range of all the templates matching the group IDs, class name IDs, class PK, name keyword, description keyword, type, mode, language, and status.search
(long companyId, long groupId, long classNameId, long classPK, long resourceClassNameId, String keywords, String type, String mode, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMTemplate> orderByComparator) Returns an ordered range of all the templates matching the group, class name ID, class PK, type, mode, and status, and matching the keywords in the template names and descriptions.search
(long companyId, long groupId, long classNameId, long classPK, long resourceClassNameId, String name, String description, String type, String mode, String language, int status, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMTemplate> orderByComparator) Returns an ordered range of all the templates matching the group, class name ID, class PK, name keyword, description keyword, type, mode, status, and language.int
searchCount
(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, long resourceClassNameId, String keywords, String type, String mode, int status) Returns the number of templates matching the group IDs, class name IDs, class PK, type, mode, and status, and matching the keywords in the template names and descriptions.int
searchCount
(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, long resourceClassNameId, String name, String description, String type, String mode, String language, int status, boolean andOperator) Returns the number of templates matching the group IDs, class name IDs, class PKs, name keyword, description keyword, type, mode, language, and status.int
searchCount
(long companyId, long groupId, long classNameId, long classPK, long resourceClassNameId, String keywords, String type, String mode, int status) Returns the number of templates matching the group, class name ID, class PK, type, mode, and status, and matching the keywords in the template names and descriptions.int
searchCount
(long companyId, long groupId, long classNameId, long classPK, long resourceClassNameId, String name, String description, String type, String mode, String language, int status, boolean andOperator) Returns the number of templates matching the group, class name ID, class PK, name keyword, description keyword, type, mode, language, and status.void
setWrappedService
(DDMTemplateLocalService ddmTemplateLocalService) updateDDMTemplate
(DDMTemplate ddmTemplate) Updates the ddm template in the database or adds it if it does not yet exist.updateTemplate
(long userId, long templateId, long classPK, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, String type, String mode, String language, String script, boolean cacheable, boolean smallImage, String smallImageURL, File smallImageFile, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the template matching the ID.updateTemplate
(long userId, long templateId, long classPK, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, String type, String mode, String language, String script, boolean cacheable, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the template matching the primary key.<R,
E extends Throwable>
RupdateWithUnsafeFunction
(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<DDMTemplate>, R, E> updateUnsafeFunction) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel
-
Constructor Details
-
DDMTemplateLocalServiceWrapper
public DDMTemplateLocalServiceWrapper() -
DDMTemplateLocalServiceWrapper
-
-
Method Details
-
addDDMTemplate
Adds the ddm template to the database. Also notifies the appropriate model listeners.Important: Inspect DDMTemplateLocalServiceImpl 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.
- Specified by:
addDDMTemplate
in interfaceDDMTemplateLocalService
- Parameters:
ddmTemplate
- the ddm template- Returns:
- the ddm template that was added
-
addTemplate
public DDMTemplate addTemplate(String externalReferenceCode, long userId, long groupId, long classNameId, long classPK, long resourceClassNameId, Map<Locale, String> nameMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, String type, String mode, String language, String script, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds a template.- Specified by:
addTemplate
in interfaceDDMTemplateLocalService
- Parameters:
externalReferenceCode
- the template's external reference codeuserId
- the primary key of the template's creator/ownergroupId
- the primary key of the groupclassNameId
- the primary key of the class name for the template's related modelclassPK
- the primary key of the template's related entityresourceClassNameId
- the primary key of the class name for template's resource modelnameMap
- the template's locales and localized namesdescriptionMap
- the template's locales and localized descriptionstype
- the template's type. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.mode
- the template's mode. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.language
- the template's script language. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.script
- the template's scriptserviceContext
- the service context to be applied. Can set the UUID, creation date, modification date, guest permissions, and group permissions for the template.- Returns:
- the template
- Throws:
PortalException
- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
addTemplate
public DDMTemplate addTemplate(String externalReferenceCode, long userId, long groupId, long classNameId, long classPK, long resourceClassNameId, String templateKey, Map<Locale, String> nameMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, String type, String mode, String language, String script, boolean cacheable, boolean smallImage, String smallImageURL, File smallImageFile, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds a template with additional parameters.- Specified by:
addTemplate
in interfaceDDMTemplateLocalService
- Parameters:
externalReferenceCode
- the template's external reference codeuserId
- the primary key of the template's creator/ownergroupId
- the primary key of the groupclassNameId
- the primary key of the class name for the template's related modelclassPK
- the primary key of the template's related entityresourceClassNameId
- the primary key of the class name for template's resource modeltemplateKey
- the unique string identifying the template (optionallynull
)nameMap
- the template's locales and localized namesdescriptionMap
- the template's locales and localized descriptionstype
- the template's type. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.mode
- the template's mode. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.language
- the template's script language. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.script
- the template's scriptcacheable
- whether the template is cacheablesmallImage
- whether the template has a small imagesmallImageURL
- the template's small image URL (optionallynull
)smallImageFile
- the template's small image file (optionallynull
)serviceContext
- the service context to be applied. Can set the UUID, creation date, modification date, guest permissions, and group permissions for the template.- Returns:
- the template
- Throws:
PortalException
- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
addTemplateResources
public void addTemplateResources(DDMTemplate template, boolean addGroupPermissions, boolean addGuestPermissions) throws com.liferay.portal.kernel.exception.PortalException Adds the resources to the template.- Specified by:
addTemplateResources
in interfaceDDMTemplateLocalService
- Parameters:
template
- the template to add resources toaddGroupPermissions
- whether to add group permissionsaddGuestPermissions
- whether to add guest permissions- Throws:
PortalException
com.liferay.portal.kernel.exception.PortalException
-
addTemplateResources
public void addTemplateResources(DDMTemplate template, com.liferay.portal.kernel.service.permission.ModelPermissions modelPermissions) throws com.liferay.portal.kernel.exception.PortalException Adds the model resources with the permissions to the template.- Specified by:
addTemplateResources
in interfaceDDMTemplateLocalService
- Parameters:
template
- the template to add resources tomodelPermissions
- the model permissions to be added- Throws:
PortalException
- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
copyTemplate
public DDMTemplate copyTemplate(long userId, long sourceTemplateId, Map<Locale, String> nameMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) Copies the template, creating a new template with all the values extracted from the original one. This method supports defining a new name and description.- Specified by:
copyTemplate
in interfaceDDMTemplateLocalService
- Parameters:
userId
- the primary key of the template's creator/ownersourceTemplateId
- the primary key of the template to be copiednameMap
- the new template's locales and localized namesdescriptionMap
- the new template's locales and localized descriptionsserviceContext
- the service context to be applied. Can set the UUID, creation date, modification date, guest permissions, and group permissions for the template.- Returns:
- the new template
- Throws:
PortalException
- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
copyTemplate
public DDMTemplate copyTemplate(long userId, long sourceTemplateId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
copyTemplate
in interfaceDDMTemplateLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
copyTemplates
public List<DDMTemplate> copyTemplates(long userId, long classNameId, long sourceClassPK, long targetClassPK, String type, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException Copies all the templates matching the class name ID, class PK, and type. This method creates new templates, extracting all the values from the old ones and updating their class PKs.- Specified by:
copyTemplates
in interfaceDDMTemplateLocalService
- Parameters:
userId
- the primary key of the template's creator/ownerclassNameId
- the primary key of the class name for the template's related modelsourceClassPK
- the primary key of the old template's related entitytargetClassPK
- the primary key of the new template's related entitytype
- the template's type. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.serviceContext
- the service context to be applied. Can set the creation date, modification date, guest permissions, and group permissions for the new templates.- Returns:
- the new templates
- Throws:
PortalException
- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
createDDMTemplate
Creates a new ddm template with the primary key. Does not add the ddm template to the database.- Specified by:
createDDMTemplate
in interfaceDDMTemplateLocalService
- Parameters:
templateId
- the primary key for the new ddm template- Returns:
- the new ddm template
-
createPersistedModel
public com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
createPersistedModel
in interfaceDDMTemplateLocalService
- Specified by:
createPersistedModel
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
- Throws:
PortalException
com.liferay.portal.kernel.exception.PortalException
-
deleteDDMTemplate
Deletes the ddm template from the database. Also notifies the appropriate model listeners.Important: Inspect DDMTemplateLocalServiceImpl 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.
- Specified by:
deleteDDMTemplate
in interfaceDDMTemplateLocalService
- Parameters:
ddmTemplate
- the ddm template- Returns:
- the ddm template that was removed
-
deleteDDMTemplate
public DDMTemplate deleteDDMTemplate(long templateId) throws com.liferay.portal.kernel.exception.PortalException Deletes the ddm template with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect DDMTemplateLocalServiceImpl 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.
- Specified by:
deleteDDMTemplate
in interfaceDDMTemplateLocalService
- Parameters:
templateId
- the primary key of the ddm template- Returns:
- the ddm template that was removed
- Throws:
PortalException
- if a ddm template with the primary key could not be foundcom.liferay.portal.kernel.exception.PortalException
-
deletePersistedModel
public 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 interfaceDDMTemplateLocalService
- Specified by:
deletePersistedModel
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
- Throws:
PortalException
com.liferay.portal.kernel.exception.PortalException
-
deleteTemplate
public DDMTemplate deleteTemplate(DDMTemplate template) throws com.liferay.portal.kernel.exception.PortalException Deletes the template and its resources.- Specified by:
deleteTemplate
in interfaceDDMTemplateLocalService
- Parameters:
template
- the template to be deleted- Throws:
PortalException
- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
deleteTemplate
public void deleteTemplate(long templateId) throws com.liferay.portal.kernel.exception.PortalException Deletes the template and its resources.- Specified by:
deleteTemplate
in interfaceDDMTemplateLocalService
- Parameters:
templateId
- the primary key of the template to be deleted- Throws:
PortalException
- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
deleteTemplate
public DDMTemplate deleteTemplate(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
deleteTemplate
in interfaceDDMTemplateLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteTemplates
public void deleteTemplates(long groupId) throws com.liferay.portal.kernel.exception.PortalException Deletes all the templates of the group.- Specified by:
deleteTemplates
in interfaceDDMTemplateLocalService
- Parameters:
groupId
- the primary key of the group- Throws:
PortalException
- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
deleteTemplates
public void deleteTemplates(long groupId, long classNameId) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
deleteTemplates
in interfaceDDMTemplateLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
dslQuery
public <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfaceDDMTemplateLocalService
- Specified by:
dslQuery
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dslQueryCount
public int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfaceDDMTemplateLocalService
- Specified by:
dslQueryCount
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dynamicQuery
public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()- Specified by:
dynamicQuery
in interfaceDDMTemplateLocalService
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Specified by:
dynamicQuery
in interfaceDDMTemplateLocalService
- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
public <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.dynamic.data.mapping.model.impl.DDMTemplateModelImpl
.- Specified by:
dynamicQuery
in interfaceDDMTemplateLocalService
- 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 <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.dynamic.data.mapping.model.impl.DDMTemplateModelImpl
.- Specified by:
dynamicQuery
in interfaceDDMTemplateLocalService
- 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 long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.- Specified by:
dynamicQueryCount
in interfaceDDMTemplateLocalService
- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
public 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.- Specified by:
dynamicQueryCount
in interfaceDDMTemplateLocalService
- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchDDMTemplate
- Specified by:
fetchDDMTemplate
in interfaceDDMTemplateLocalService
-
fetchDDMTemplateByExternalReferenceCode
public DDMTemplate fetchDDMTemplateByExternalReferenceCode(String externalReferenceCode, long groupId) - Specified by:
fetchDDMTemplateByExternalReferenceCode
in interfaceDDMTemplateLocalService
-
fetchDDMTemplateByExternalReferenceCode
public DDMTemplate fetchDDMTemplateByExternalReferenceCode(String externalReferenceCode, long groupId, boolean includeAncestorTemplates) - Specified by:
fetchDDMTemplateByExternalReferenceCode
in interfaceDDMTemplateLocalService
-
fetchDDMTemplateByUuidAndGroupId
Returns the ddm template matching the UUID and group.- Specified by:
fetchDDMTemplateByUuidAndGroupId
in interfaceDDMTemplateLocalService
- Parameters:
uuid
- the ddm template's UUIDgroupId
- the primary key of the group- Returns:
- the matching ddm template, or
null
if a matching ddm template could not be found
-
fetchTemplate
Returns the template with the primary key.- Specified by:
fetchTemplate
in interfaceDDMTemplateLocalService
- Parameters:
templateId
- the primary key of the template- Returns:
- the matching template, or
null
if a matching template could not be found
-
fetchTemplate
Returns the template matching the group and template key.- Specified by:
fetchTemplate
in interfaceDDMTemplateLocalService
- Parameters:
groupId
- the primary key of the groupclassNameId
- the primary key of the class name for the template's related modeltemplateKey
- the unique string identifying the template- Returns:
- the matching template, or
null
if a matching template could not be found
-
fetchTemplate
public DDMTemplate fetchTemplate(long groupId, long classNameId, String templateKey, boolean includeAncestorTemplates) Returns the template matching the group and template key, optionally searching ancestor sites (that have sharing enabled) and global scoped sites.This method first searches in the given group. If the template is still not found and
includeAncestorTemplates
is set totrue
, this method searches the group's ancestor sites (that have sharing enabled) and lastly searches global scoped sites.- Specified by:
fetchTemplate
in interfaceDDMTemplateLocalService
- Parameters:
groupId
- the primary key of the groupclassNameId
- the primary key of the class name for the template's related modeltemplateKey
- the unique string identifying the templateincludeAncestorTemplates
- whether to include ancestor sites (that have sharing enabled) and include global scoped sites in the search in the search- Returns:
- the matching template, or
null
if a matching template could not be found
-
getActionableDynamicQuery
public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()- Specified by:
getActionableDynamicQuery
in interfaceDDMTemplateLocalService
-
getDDMTemplate
public DDMTemplate getDDMTemplate(long templateId) throws com.liferay.portal.kernel.exception.PortalException Returns the ddm template with the primary key.- Specified by:
getDDMTemplate
in interfaceDDMTemplateLocalService
- Parameters:
templateId
- the primary key of the ddm template- Returns:
- the ddm template
- Throws:
PortalException
- if a ddm template with the primary key could not be foundcom.liferay.portal.kernel.exception.PortalException
-
getDDMTemplateByExternalReferenceCode
public DDMTemplate getDDMTemplateByExternalReferenceCode(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getDDMTemplateByExternalReferenceCode
in interfaceDDMTemplateLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getDDMTemplateByUuidAndGroupId
public DDMTemplate getDDMTemplateByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException Returns the ddm template matching the UUID and group.- Specified by:
getDDMTemplateByUuidAndGroupId
in interfaceDDMTemplateLocalService
- Parameters:
uuid
- the ddm template's UUIDgroupId
- the primary key of the group- Returns:
- the matching ddm template
- Throws:
PortalException
- if a matching ddm template could not be foundcom.liferay.portal.kernel.exception.PortalException
-
getDDMTemplates
Returns a range of all the ddm 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.dynamic.data.mapping.model.impl.DDMTemplateModelImpl
.- Specified by:
getDDMTemplates
in interfaceDDMTemplateLocalService
- Parameters:
start
- the lower bound of the range of ddm templatesend
- the upper bound of the range of ddm templates (not inclusive)- Returns:
- the range of ddm templates
-
getDDMTemplatesByUuidAndCompanyId
Returns all the ddm templates matching the UUID and company.- Specified by:
getDDMTemplatesByUuidAndCompanyId
in interfaceDDMTemplateLocalService
- Parameters:
uuid
- the UUID of the ddm templatescompanyId
- the primary key of the company- Returns:
- the matching ddm templates, or an empty list if no matches were found
-
getDDMTemplatesByUuidAndCompanyId
public List<DDMTemplate> getDDMTemplatesByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMTemplate> orderByComparator) Returns a range of ddm templates matching the UUID and company.- Specified by:
getDDMTemplatesByUuidAndCompanyId
in interfaceDDMTemplateLocalService
- Parameters:
uuid
- the UUID of the ddm templatescompanyId
- the primary key of the companystart
- the lower bound of the range of ddm templatesend
- the upper bound of the range of ddm templates (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the range of matching ddm templates, or an empty list if no matches were found
-
getDDMTemplatesCount
public int getDDMTemplatesCount()Returns the number of ddm templates.- Specified by:
getDDMTemplatesCount
in interfaceDDMTemplateLocalService
- Returns:
- the number of ddm templates
-
getExportActionableDynamicQuery
public com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) - Specified by:
getExportActionableDynamicQuery
in interfaceDDMTemplateLocalService
-
getIndexableActionableDynamicQuery
public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()- Specified by:
getIndexableActionableDynamicQuery
in interfaceDDMTemplateLocalService
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Specified by:
getOSGiServiceIdentifier
in interfaceDDMTemplateLocalService
- Returns:
- the OSGi service identifier
-
getPersistedModel
public com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getPersistedModel
in interfaceDDMTemplateLocalService
- Specified by:
getPersistedModel
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
- Throws:
PortalException
com.liferay.portal.kernel.exception.PortalException
-
getTemplate
public DDMTemplate getTemplate(long templateId) throws com.liferay.portal.kernel.exception.PortalException Returns the template with the primary key.- Specified by:
getTemplate
in interfaceDDMTemplateLocalService
- Parameters:
templateId
- the primary key of the template- Returns:
- the template with the primary key
- Throws:
PortalException
- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getTemplate
public DDMTemplate getTemplate(long groupId, long classNameId, String templateKey) throws com.liferay.portal.kernel.exception.PortalException Returns the template matching the group and template key.- Specified by:
getTemplate
in interfaceDDMTemplateLocalService
- Parameters:
groupId
- the primary key of the groupclassNameId
- the primary key of the class name for the template's related modeltemplateKey
- the unique string identifying the template- Returns:
- the matching template
- Throws:
PortalException
- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getTemplate
public DDMTemplate getTemplate(long groupId, long classNameId, String templateKey, boolean includeAncestorTemplates) throws com.liferay.portal.kernel.exception.PortalException Returns the template matching the group and template key, optionally searching ancestor sites (that have sharing enabled) and global scoped sites.This method first searches in the group. If the template is still not found and
includeAncestorTemplates
is set totrue
, this method searches the group's ancestor sites (that have sharing enabled) and lastly searches global scoped sites.- Specified by:
getTemplate
in interfaceDDMTemplateLocalService
- Parameters:
groupId
- the primary key of the groupclassNameId
- the primary key of the class name for the template's related modeltemplateKey
- the unique string identifying the templateincludeAncestorTemplates
- whether to include ancestor sites (that have sharing enabled) and include global scoped sites in the search in the search- Returns:
- the matching template
- Throws:
PortalException
- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getTemplateBySmallImageId
public DDMTemplate getTemplateBySmallImageId(long smallImageId) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getTemplateBySmallImageId
in interfaceDDMTemplateLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getTemplates
Returns all the templates with the class PK.- Specified by:
getTemplates
in interfaceDDMTemplateLocalService
- Parameters:
classPK
- the primary key of the template's related entity- Returns:
- the templates with the class PK
-
getTemplates
Returns all the templates matching the group and class name ID.- Specified by:
getTemplates
in interfaceDDMTemplateLocalService
- Parameters:
groupId
- the primary key of the groupclassNameId
- the primary key of the class name for the template's related model- Returns:
- the matching templates
-
getTemplates
Returns all the templates matching the group, class name ID, and class PK.- Specified by:
getTemplates
in interfaceDDMTemplateLocalService
- Parameters:
groupId
- the primary key of the groupclassNameId
- the primary key of the class name for the template's related modelclassPK
- the primary key of the template's related entity- Returns:
- the matching templates
-
getTemplates
public List<DDMTemplate> getTemplates(long groupId, long classNameId, long classPK, boolean includeAncestorTemplates) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getTemplates
in interfaceDDMTemplateLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getTemplates
Returns all the templates matching the group, class name ID, class PK, and type.- Specified by:
getTemplates
in interfaceDDMTemplateLocalService
- Parameters:
groupId
- the primary key of the groupclassNameId
- the primary key of the class name for the template's related modelclassPK
- the primary key of the template's related entitytype
- the template's type. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.- Returns:
- the matching templates
-
getTemplates
public List<DDMTemplate> getTemplates(long groupId, long classNameId, long classPK, String type, String mode) Returns all the templates matching the group, class name ID, class PK, type, and mode.- Specified by:
getTemplates
in interfaceDDMTemplateLocalService
- Parameters:
groupId
- the primary key of the groupclassNameId
- the primary key of the class name for the template's related modelclassPK
- the primary key of the template's related entitytype
- the template's type. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.mode
- the template's mode. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.- Returns:
- the matching templates
-
getTemplates
public List<DDMTemplate> getTemplates(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, long resourceClassNameId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMTemplate> orderByComparator) - Specified by:
getTemplates
in interfaceDDMTemplateLocalService
-
getTemplates
- Specified by:
getTemplates
in interfaceDDMTemplateLocalService
-
getTemplatesByClassPK
- Specified by:
getTemplatesByClassPK
in interfaceDDMTemplateLocalService
-
getTemplatesByClassPK
- Specified by:
getTemplatesByClassPK
in interfaceDDMTemplateLocalService
-
getTemplatesByClassPK
- Specified by:
getTemplatesByClassPK
in interfaceDDMTemplateLocalService
-
getTemplatesByClassPKCount
public int getTemplatesByClassPKCount(long groupId, long classPK) Returns the number of templates matching the group and class PK.- Specified by:
getTemplatesByClassPKCount
in interfaceDDMTemplateLocalService
- Parameters:
groupId
- the primary key of the groupclassPK
- the primary key of the template's related entity- Returns:
- the number of templates belonging to the group and class PK
-
getTemplatesByGroupId
- Specified by:
getTemplatesByGroupId
in interfaceDDMTemplateLocalService
-
getTemplatesByStructureClassNameId
public List<DDMTemplate> getTemplatesByStructureClassNameId(long groupId, long structureClassNameId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMTemplate> orderByComparator) Returns an ordered range of all the templates matching the group, structure class name ID, and status.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
toQueryUtil#ALL_POS
will return the full result set.- Specified by:
getTemplatesByStructureClassNameId
in interfaceDDMTemplateLocalService
- Parameters:
groupId
- the primary key of the groupstructureClassNameId
- the primary key of the class name for the template's related structurestatus
- the template's workflow status. For more information seeWorkflowConstants
for constants starting with the "STATUS_" prefix.start
- the lower bound of the range of templates to returnend
- the upper bound of the range of templates to return (not inclusive)orderByComparator
- the comparator to order the templates (optionallynull
)- Returns:
- the range of matching templates ordered by the comparator
-
getTemplatesByStructureClassNameIdCount
public int getTemplatesByStructureClassNameIdCount(long groupId, long structureClassNameId, int status) Returns the number of templates matching the group, structure class name ID, and status, including Generic Templates.- Specified by:
getTemplatesByStructureClassNameIdCount
in interfaceDDMTemplateLocalService
- Parameters:
groupId
- the primary key of the groupstructureClassNameId
- the primary key of the class name for the template's related structurestatus
- the template's workflow status. For more information seeWorkflowConstants
for constants starting with the "STATUS_" prefix.- Returns:
- the number of matching templates
-
getTemplatesCount
public int getTemplatesCount(long groupId) Returns the number of templates belonging to the group.- Specified by:
getTemplatesCount
in interfaceDDMTemplateLocalService
- Parameters:
groupId
- the primary key of the group- Returns:
- the number of templates belonging to the group
-
getTemplatesCount
public int getTemplatesCount(long groupId, long classNameId) Returns the number of templates matching the group and class name ID.- Specified by:
getTemplatesCount
in interfaceDDMTemplateLocalService
- Parameters:
groupId
- the primary key of the groupclassNameId
- the primary key of the class name for the template's related model- Returns:
- the number of matching templates
-
getTemplatesCount
public int getTemplatesCount(long groupId, long classNameId, long classPK) Returns the number of templates matching the group, class name ID, and class PK.- Specified by:
getTemplatesCount
in interfaceDDMTemplateLocalService
- Parameters:
groupId
- the primary key of the groupclassNameId
- the primary key of the class name for the template's related modelclassPK
- the primary key of the template's related entity- Returns:
- the number of matching templates
-
getTemplatesCount
public int getTemplatesCount(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, long resourceClassNameId) - Specified by:
getTemplatesCount
in interfaceDDMTemplateLocalService
-
getTemplatesCount
public int getTemplatesCount(long[] groupIds, long classNameId, long classPK) Returns the number of templates matching the group IDs, class name ID, and class PK.- Specified by:
getTemplatesCount
in interfaceDDMTemplateLocalService
- Parameters:
groupIds
- the primary keys of the groupsclassNameId
- the primary key of the class name for the template's related modelclassPK
- the primary key of the template's related entity- Returns:
- the number of matching templates
-
revertTemplate
public void revertTemplate(long userId, long templateId, String version, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
revertTemplate
in interfaceDDMTemplateLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
search
public List<DDMTemplate> search(long companyId, long groupId, long classNameId, long classPK, long resourceClassNameId, String keywords, String type, String mode, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMTemplate> orderByComparator) Returns an ordered range of all the templates matching the group, class name ID, class PK, type, mode, and status, and matching the keywords in the template names and descriptions.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
toQueryUtil#ALL_POS
will return the full result set.- Specified by:
search
in interfaceDDMTemplateLocalService
- Parameters:
companyId
- the primary key of the template's companygroupId
- the primary key of the groupclassNameId
- the primary key of the class name for the template's related modelclassPK
- the primary key of the template's related entityresourceClassNameId
- the primary key of the class name for template's resource modelkeywords
- the keywords (space separated), which may occur in the template's name or description (optionallynull
)type
- the template's type (optionallynull
). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.mode
- the template's mode (optionallynull
). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.status
- the template's workflow status. For more information seeWorkflowConstants
for constants starting with the "STATUS_" prefix.start
- the lower bound of the range of templates to returnend
- the upper bound of the range of templates to return (not inclusive)orderByComparator
- the comparator to order the templates (optionallynull
)- Returns:
- the range of matching templates ordered by the comparator
-
search
public List<DDMTemplate> search(long companyId, long groupId, long classNameId, long classPK, long resourceClassNameId, String name, String description, String type, String mode, String language, int status, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMTemplate> orderByComparator) Returns an ordered range of all the templates matching the group, class name ID, class PK, name keyword, description keyword, type, mode, status, and language.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
toQueryUtil#ALL_POS
will return the full result set.- Specified by:
search
in interfaceDDMTemplateLocalService
- Parameters:
companyId
- the primary key of the template's companygroupId
- the primary key of the groupclassNameId
- the primary key of the class name for the template's related modelclassPK
- the primary key of the template's related entityresourceClassNameId
- the primary key of the class name for template's resource modelname
- the name keywords (optionallynull
)description
- the description keywords (optionallynull
)type
- the template's type (optionallynull
). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.mode
- the template's mode (optionallynull
). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.language
- the template's script language (optionallynull
). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.status
- the template's workflow status. For more information seeWorkflowConstants
for constants starting with the "STATUS_" prefix.andOperator
- whether every field must match its keywords, or just one fieldstart
- the lower bound of the range of templates to returnend
- the upper bound of the range of templates to return (not inclusive)orderByComparator
- the comparator to order the templates (optionallynull
)- Returns:
- the range of matching templates ordered by the comparator
-
search
public List<DDMTemplate> search(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, long resourceClassNameId, String keywords, String type, String mode, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMTemplate> orderByComparator) Returns an ordered range of all the templates matching the group IDs, class Name IDs, class PK, type, mode, and status, and include the keywords on its names and descriptions.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
toQueryUtil#ALL_POS
will return the full result set.- Specified by:
search
in interfaceDDMTemplateLocalService
- Parameters:
companyId
- the primary key of the template's companygroupIds
- the primary keys of the groupsclassNameIds
- the primary keys of the entity's instances the templates are related toclassPKs
- the primary keys of the template's related entitiesresourceClassNameId
- the primary key of the class name for template's resource modelkeywords
- the keywords (space separated), which may occur in the template's name or description (optionallynull
)type
- the template's type (optionallynull
). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.mode
- the template's mode (optionallynull
). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.status
- the template's workflow status. For more information seeWorkflowConstants
for constants starting with the "STATUS_" prefix.start
- the lower bound of the range of templates to returnend
- the upper bound of the range of templates to return (not inclusive)orderByComparator
- the comparator to order the templates (optionallynull
)- Returns:
- the range of matching templates ordered by the comparator
-
search
public List<DDMTemplate> search(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, long resourceClassNameId, String name, String description, String type, String mode, String language, int status, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMTemplate> orderByComparator) Returns an ordered range of all the templates matching the group IDs, class name IDs, class PK, name keyword, description keyword, type, mode, language, and status.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
toQueryUtil#ALL_POS
will return the full result set.- Specified by:
search
in interfaceDDMTemplateLocalService
- Parameters:
companyId
- the primary key of the template's companygroupIds
- the primary keys of the groupsclassNameIds
- the primary keys of the entity's instances the templates are related toclassPKs
- the primary keys of the template's related entitiesresourceClassNameId
- the primary key of the class name for template's resource modelname
- the name keywords (optionallynull
)description
- the description keywords (optionallynull
)type
- the template's type (optionallynull
). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.mode
- the template's mode (optionallynull
). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.language
- the template's script language (optionallynull
). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.status
- the template's workflow status. For more information seeWorkflowConstants
for constants starting with the "STATUS_" prefix.andOperator
- whether every field must match its keywords, or just one field.start
- the lower bound of the range of templates to returnend
- the upper bound of the range of templates to return (not inclusive)orderByComparator
- the comparator to order the templates (optionallynull
)- Returns:
- the range of matching templates ordered by the comparator
-
searchCount
public int searchCount(long companyId, long groupId, long classNameId, long classPK, long resourceClassNameId, String keywords, String type, String mode, int status) Returns the number of templates matching the group, class name ID, class PK, type, mode, and status, and matching the keywords in the template names and descriptions.- Specified by:
searchCount
in interfaceDDMTemplateLocalService
- Parameters:
companyId
- the primary key of the template's companygroupId
- the primary key of the groupclassNameId
- the primary key of the class name for the template's related modelclassPK
- the primary key of the template's related entityresourceClassNameId
- the primary key of the class name for template's resource modelkeywords
- the keywords (space separated), which may occur in the template's name or description (optionallynull
)type
- the template's type (optionallynull
). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.mode
- the template's mode (optionallynull
). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.status
- the template's workflow status. For more information seeWorkflowConstants
for constants starting with the "STATUS_" prefix.- Returns:
- the number of matching templates
-
searchCount
public int searchCount(long companyId, long groupId, long classNameId, long classPK, long resourceClassNameId, String name, String description, String type, String mode, String language, int status, boolean andOperator) Returns the number of templates matching the group, class name ID, class PK, name keyword, description keyword, type, mode, language, and status.- Specified by:
searchCount
in interfaceDDMTemplateLocalService
- Parameters:
companyId
- the primary key of the template's companygroupId
- the primary key of the groupclassNameId
- the primary key of the class name for the template's related modelclassPK
- the primary key of the template's related entityresourceClassNameId
- the primary key of the class name for template's resource modelname
- the name keywords (optionallynull
)description
- the description keywords (optionallynull
)type
- the template's type (optionallynull
). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.mode
- the template's mode (optionallynull
). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.language
- the template's script language (optionallynull
). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.status
- the template's workflow status. For more information seeWorkflowConstants
for constants starting with the "STATUS_" prefix.andOperator
- whether every field must match its keywords, or just one field.- Returns:
- the number of matching templates
-
searchCount
public int searchCount(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, long resourceClassNameId, String keywords, String type, String mode, int status) Returns the number of templates matching the group IDs, class name IDs, class PK, type, mode, and status, and matching the keywords in the template names and descriptions.- Specified by:
searchCount
in interfaceDDMTemplateLocalService
- Parameters:
companyId
- the primary key of the template's companygroupIds
- the primary keys of the groupsclassNameIds
- the primary keys of the entity's instance the templates are related toclassPKs
- the primary keys of the template's related entitiesresourceClassNameId
- the primary key of the class name for template's resource modelkeywords
- the keywords (space separated), which may occur in the template's name or description (optionallynull
)type
- the template's type (optionallynull
). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.mode
- the template's mode (optionallynull
). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.status
- the template's workflow status. For more information seeWorkflowConstants
for constants starting with the "STATUS_" prefix.- Returns:
- the number of matching templates
-
searchCount
public int searchCount(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, long resourceClassNameId, String name, String description, String type, String mode, String language, int status, boolean andOperator) Returns the number of templates matching the group IDs, class name IDs, class PKs, name keyword, description keyword, type, mode, language, and status.- Specified by:
searchCount
in interfaceDDMTemplateLocalService
- Parameters:
companyId
- the primary key of the templates companygroupIds
- the primary keys of the groupsclassNameIds
- the primary keys of the entity's instance the templates are related toclassPKs
- the primary keys of the template's related entitiesresourceClassNameId
- the primary key of the class name for template's resource modelname
- the name keywords (optionallynull
)description
- the description keywords (optionallynull
)type
- the template's type (optionallynull
). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.mode
- the template's mode (optionallynull
). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.language
- the template's script language (optionallynull
). For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.status
- the template's workflow status. For more information seeWorkflowConstants
for constants starting with the "STATUS_" prefix.andOperator
- whether every field must match its keywords, or just one field.- Returns:
- the number of matching templates
-
updateDDMTemplate
Updates the ddm template in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect DDMTemplateLocalServiceImpl 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.
- Specified by:
updateDDMTemplate
in interfaceDDMTemplateLocalService
- Parameters:
ddmTemplate
- the ddm template- Returns:
- the ddm template that was updated
-
updateTemplate
public DDMTemplate updateTemplate(long userId, long templateId, long classPK, Map<Locale, String> nameMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, String type, String mode, String language, String script, boolean cacheable, boolean smallImage, String smallImageURL, File smallImageFile, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the template matching the ID.- Specified by:
updateTemplate
in interfaceDDMTemplateLocalService
- Parameters:
userId
- the primary key of the template's creator/ownertemplateId
- the primary key of the templateclassPK
- the primary key of the template's related entitynameMap
- the template's new locales and localized namesdescriptionMap
- the template's new locales and localized descriptiontype
- the template's type. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.mode
- the template's mode. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.language
- the template's script language. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.script
- the template's scriptcacheable
- whether the template is cacheablesmallImage
- whether the template has a small imagesmallImageURL
- the template's small image URL (optionallynull
)smallImageFile
- the template's small image file (optionallynull
)serviceContext
- the service context to be applied. Can set the modification date.- Returns:
- the updated template
- Throws:
PortalException
- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
updateTemplate
public DDMTemplate updateTemplate(long userId, long templateId, long classPK, Map<Locale, String> nameMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, String type, String mode, String language, String script, boolean cacheable, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the template matching the primary key.- Specified by:
updateTemplate
in interfaceDDMTemplateLocalService
- Parameters:
userId
- the primary key of the template's creator/ownertemplateId
- the primary key of the templateclassPK
- the primary key of the template's related entitynameMap
- the template's new locales and localized namesdescriptionMap
- the template's new locales and localized descriptiontype
- the template's type. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.mode
- the template's mode. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.language
- the template's script language. For more information, see DDMTemplateConstants in the dynamic-data-mapping-api module.script
- the template's scriptcacheable
- whether the template is cacheableserviceContext
- the service context to be applied. Can set the modification date.- Returns:
- the updated template
- Throws:
PortalException
- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getBasePersistence
public com.liferay.portal.kernel.service.persistence.BasePersistence<?> getBasePersistence()- Specified by:
getBasePersistence
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
getCTPersistence
public com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<DDMTemplate> getCTPersistence()- Specified by:
getCTPersistence
in interfacecom.liferay.portal.kernel.service.change.tracking.CTService<DDMTemplate>
- Specified by:
getCTPersistence
in interfaceDDMTemplateLocalService
-
getModelClass
- Specified by:
getModelClass
in interfacecom.liferay.portal.kernel.service.change.tracking.CTService<DDMTemplate>
- Specified by:
getModelClass
in interfaceDDMTemplateLocalService
-
updateWithUnsafeFunction
public <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<DDMTemplate>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunction
in interfacecom.liferay.portal.kernel.service.change.tracking.CTService<DDMTemplate>
- Specified by:
updateWithUnsafeFunction
in interfaceDDMTemplateLocalService
- Throws:
E extends Throwable
-
getWrappedService
- Specified by:
getWrappedService
in interfacecom.liferay.portal.kernel.service.ServiceWrapper<DDMTemplateLocalService>
-
setWrappedService
- Specified by:
setWrappedService
in interfacecom.liferay.portal.kernel.service.ServiceWrapper<DDMTemplateLocalService>
-