|
Liferay 7.0-ce-m3 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portlet.dynamicdatamapping.service.DDMTemplateLocalServiceWrapper
@ProviderType public class DDMTemplateLocalServiceWrapper
Provides a wrapper for DDMTemplateLocalService.
DDMTemplateLocalService| Constructor Summary | |
|---|---|
DDMTemplateLocalServiceWrapper(DDMTemplateLocalService ddmTemplateLocalService)
|
|
| Method Summary | ||
|---|---|---|
DDMTemplate |
addDDMTemplate(DDMTemplate ddmTemplate)
Adds the d d m template to the database. |
|
DDMTemplate |
addTemplate(long userId,
long groupId,
long classNameId,
long classPK,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String type,
String mode,
String language,
String script,
ServiceContext serviceContext)
Adds a template. |
|
DDMTemplate |
addTemplate(long userId,
long groupId,
long classNameId,
long classPK,
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,
ServiceContext serviceContext)
Adds a template with additional parameters. |
|
void |
addTemplateResources(DDMTemplate template,
boolean addGroupPermissions,
boolean addGuestPermissions)
Adds the resources to the template. |
|
void |
addTemplateResources(DDMTemplate template,
String[] groupPermissions,
String[] guestPermissions)
Adds the model resources with the permissions to the template. |
|
DDMTemplate |
copyTemplate(long userId,
long templateId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
ServiceContext serviceContext)
Copies the template, creating a new template with all the values extracted from the original one. |
|
DDMTemplate |
copyTemplate(long userId,
long templateId,
ServiceContext serviceContext)
|
|
List<DDMTemplate> |
copyTemplates(long userId,
long classNameId,
long oldClassPK,
long newClassPK,
String type,
ServiceContext serviceContext)
Copies all the templates matching the class name ID, class PK, and type. |
|
DDMTemplate |
createDDMTemplate(long templateId)
Creates a new d d m template with the primary key. |
|
DDMTemplate |
deleteDDMTemplate(DDMTemplate ddmTemplate)
Deletes the d d m template from the database. |
|
DDMTemplate |
deleteDDMTemplate(long templateId)
Deletes the d d m template with the primary key from the database. |
|
PersistedModel |
deletePersistedModel(PersistedModel persistedModel)
|
|
void |
deleteTemplate(DDMTemplate template)
Deletes the template and its resources. |
|
void |
deleteTemplate(long templateId)
Deletes the template and its resources. |
|
void |
deleteTemplates(long groupId)
Deletes all the templates of the group. |
|
void |
deleteTemplates(long groupId,
long classNameId)
|
|
DynamicQuery |
dynamicQuery()
|
|
|
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
|
|
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
|
|
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. |
|
long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query. |
|
long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows matching the dynamic query. |
|
DDMTemplate |
fetchDDMTemplate(long templateId)
|
|
DDMTemplate |
fetchDDMTemplateByUuidAndGroupId(String uuid,
long groupId)
Returns the d d m template matching the UUID and group. |
|
DDMTemplate |
fetchTemplate(long groupId,
long classNameId,
String templateKey)
Returns the template matching the group and template key. |
|
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. |
|
ActionableDynamicQuery |
getActionableDynamicQuery()
|
|
String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
|
DDMTemplate |
getDDMTemplate(long templateId)
Returns the d d m template with the primary key. |
|
DDMTemplate |
getDDMTemplateByUuidAndGroupId(String uuid,
long groupId)
Returns the d d m template matching the UUID and group. |
|
List<DDMTemplate> |
getDDMTemplates(int start,
int end)
Returns a range of all the d d m templates. |
|
List<DDMTemplate> |
getDDMTemplatesByUuidAndCompanyId(String uuid,
long companyId)
Returns all the d d m templates matching the UUID and company. |
|
List<DDMTemplate> |
getDDMTemplatesByUuidAndCompanyId(String uuid,
long companyId,
int start,
int end,
OrderByComparator<DDMTemplate> orderByComparator)
Returns a range of d d m templates matching the UUID and company. |
|
int |
getDDMTemplatesCount()
Returns the number of d d m templates. |
|
ExportActionableDynamicQuery |
getExportActionableDynamicQuery(PortletDataContext portletDataContext)
|
|
PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
|
DDMTemplate |
getTemplate(long templateId)
Returns the template with the ID. |
|
DDMTemplate |
getTemplate(long groupId,
long classNameId,
String templateKey)
Returns the template matching the group and template key. |
|
DDMTemplate |
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. |
|
DDMTemplate |
getTemplateBySmallImageId(long smallImageId)
|
|
List<DDMTemplate> |
getTemplates(long classPK)
Returns all the templates with the class PK. |
|
List<DDMTemplate> |
getTemplates(long[] groupIds,
long classNameId,
long classPK)
|
|
List<DDMTemplate> |
getTemplates(long groupId,
long classNameId)
Returns all the templates matching the group and class name ID. |
|
List<DDMTemplate> |
getTemplates(long groupId,
long classNameId,
long classPK)
Returns all the templates matching the group, class name ID, and class PK. |
|
List<DDMTemplate> |
getTemplates(long groupId,
long classNameId,
long classPK,
boolean includeAncestorTemplates)
|
|
List<DDMTemplate> |
getTemplates(long groupId,
long classNameId,
long classPK,
String type)
Returns all the templates matching the group, class name ID, class PK, and type. |
|
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. |
|
List<DDMTemplate> |
getTemplatesByClassPK(long[] groupIds,
long classPK)
|
|
List<DDMTemplate> |
getTemplatesByClassPK(long groupId,
long classPK)
|
|
List<DDMTemplate> |
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. |
|
List<DDMTemplate> |
getTemplatesByStructureClassNameId(long groupId,
long structureClassNameId,
int start,
int end,
OrderByComparator<DDMTemplate> orderByComparator)
Returns an ordered range of all the templates matching the group and structure class name ID. |
|
int |
getTemplatesByStructureClassNameIdCount(long groupId,
long structureClassNameId)
Returns the number of templates matching the group and structure class name ID, including Generic Templates. |
|
int |
getTemplatesCount(long groupId)
Returns the number of templates belonging to the group. |
|
int |
getTemplatesCount(long groupId,
long classNameId)
Returns the number of templates matching the group and class name ID. |
|
int |
getTemplatesCount(long groupId,
long classNameId,
long classPK)
Returns the number of templates matching the group, class name ID, and class PK. |
|
DDMTemplateLocalService |
getWrappedDDMTemplateLocalService()
Deprecated. As of 6.1.0, replaced by getWrappedService() |
|
DDMTemplateLocalService |
getWrappedService()
|
|
List<DDMTemplate> |
search(long companyId,
long[] groupIds,
long[] classNameIds,
long[] classPKs,
String keywords,
String type,
String mode,
int start,
int end,
OrderByComparator<DDMTemplate> orderByComparator)
Returns an ordered range of all the templates matching the group IDs, class Name IDs, class PK, type, and mode, and include the keywords on its names and descriptions. |
|
List<DDMTemplate> |
search(long companyId,
long[] groupIds,
long[] classNameIds,
long[] classPKs,
String name,
String description,
String type,
String mode,
String language,
boolean andOperator,
int start,
int end,
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, and language. |
|
List<DDMTemplate> |
search(long companyId,
long groupId,
long classNameId,
long classPK,
String keywords,
String type,
String mode,
int start,
int end,
OrderByComparator<DDMTemplate> orderByComparator)
Returns an ordered range of all the templates matching the group, class name ID, class PK, type, and mode, and matching the keywords in the template names and descriptions. |
|
List<DDMTemplate> |
search(long companyId,
long groupId,
long classNameId,
long classPK,
String name,
String description,
String type,
String mode,
String language,
boolean andOperator,
int start,
int end,
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, and language. |
|
int |
searchCount(long companyId,
long[] groupIds,
long[] classNameIds,
long[] classPKs,
String keywords,
String type,
String mode)
Returns the number of templates matching the group IDs, class name IDs, class PK, type, and mode, and matching the keywords in the template names and descriptions. |
|
int |
searchCount(long companyId,
long[] groupIds,
long[] classNameIds,
long[] classPKs,
String name,
String description,
String type,
String mode,
String language,
boolean andOperator)
Returns the number of templates matching the group IDs, class name IDs, class PKs, name keyword, description keyword, type, mode, and language. |
|
int |
searchCount(long companyId,
long groupId,
long classNameId,
long classPK,
String keywords,
String type,
String mode)
Returns the number of templates matching the group, class name ID, class PK, type, and matching the keywords in the template names and descriptions. |
|
int |
searchCount(long companyId,
long groupId,
long classNameId,
long classPK,
String name,
String description,
String type,
String mode,
String language,
boolean andOperator)
Returns the number of templates matching the group, class name ID, class PK, name keyword, description keyword, type, mode, and language. |
|
void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
|
void |
setWrappedDDMTemplateLocalService(DDMTemplateLocalService ddmTemplateLocalService)
Deprecated. As of 6.1.0, replaced by setWrappedService(com.liferay.portlet.dynamicdatamapping.service.DDMTemplateLocalService) |
|
void |
setWrappedService(DDMTemplateLocalService ddmTemplateLocalService)
|
|
DDMTemplate |
updateDDMTemplate(DDMTemplate ddmTemplate)
Updates the d d m template in the database or adds it if it does not yet exist. |
|
DDMTemplate |
updateTemplate(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,
ServiceContext serviceContext)
Updates the template matching the ID. |
|
DDMTemplate |
updateTemplate(long templateId,
long classPK,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String type,
String mode,
String language,
String script,
boolean cacheable,
ServiceContext serviceContext)
Updates the template matching the ID. |
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public DDMTemplateLocalServiceWrapper(DDMTemplateLocalService ddmTemplateLocalService)
| Method Detail |
|---|
public DDMTemplate addDDMTemplate(DDMTemplate ddmTemplate)
addDDMTemplate in interface DDMTemplateLocalServiceddmTemplate - the d d m template
public DDMTemplate addTemplate(long userId,
long groupId,
long classNameId,
long classPK,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String type,
String mode,
String language,
String script,
ServiceContext serviceContext)
throws PortalException
addTemplate in interface DDMTemplateLocalServiceuserId - 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 entitynameMap - the template's locales and localized namesdescriptionMap - the template's locales and localized descriptionstype - the template's type. For more information, see DDMTemplateConstants.mode - the template's mode. For more information, see DDMTemplateConstants.language - the template's script language. For more information,
see DDMTemplateConstants.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.
PortalException - if a portal exception occurred
public DDMTemplate addTemplate(long userId,
long groupId,
long classNameId,
long classPK,
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,
ServiceContext serviceContext)
throws PortalException
addTemplate in interface DDMTemplateLocalServiceuserId - 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 entitytemplateKey - the unique string identifying the template
(optionally null)nameMap - the template's locales and localized namesdescriptionMap - the template's locales and localized descriptionstype - the template's type. For more information, see DDMTemplateConstants.mode - the template's mode. For more information, see DDMTemplateConstants.language - the template's script language. For more information,
see DDMTemplateConstants.script - the template's scriptcacheable - whether the template is cacheablesmallImage - whether the template has a small imagesmallImageURL - the template's small image URL (optionally
null)smallImageFile - the template's small image file (optionally
null)serviceContext - the service context to be applied. Can set the
UUID, creation date, modification date, guest permissions, and
group permissions for the template.
PortalException - if a portal exception occurred
public void addTemplateResources(DDMTemplate template,
boolean addGroupPermissions,
boolean addGuestPermissions)
throws PortalException
addTemplateResources in interface DDMTemplateLocalServicetemplate - the template to add resources toaddGroupPermissions - whether to add group permissionsaddGuestPermissions - whether to add guest permissions
PortalException - if a portal exception occurred
public void addTemplateResources(DDMTemplate template,
String[] groupPermissions,
String[] guestPermissions)
throws PortalException
addTemplateResources in interface DDMTemplateLocalServicetemplate - the template to add resources togroupPermissions - the group permissions to be addedguestPermissions - the guest permissions to be added
PortalException - if a portal exception occurred
public DDMTemplate copyTemplate(long userId,
long templateId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
ServiceContext serviceContext)
throws PortalException
copyTemplate in interface DDMTemplateLocalServiceuserId - the primary key of the template's creator/ownertemplateId - 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.
PortalException - if a portal exception occurred
public DDMTemplate copyTemplate(long userId,
long templateId,
ServiceContext serviceContext)
throws PortalException
copyTemplate in interface DDMTemplateLocalServicePortalException
public List<DDMTemplate> copyTemplates(long userId,
long classNameId,
long oldClassPK,
long newClassPK,
String type,
ServiceContext serviceContext)
throws PortalException
copyTemplates in interface DDMTemplateLocalServiceuserId - the primary key of the template's creator/ownerclassNameId - the primary key of the class name for the template's
related modeloldClassPK - the primary key of the old template's related entitynewClassPK - the primary key of the new template's related entitytype - the template's type. For more information, see DDMTemplateConstants.serviceContext - the service context to be applied. Can set the
creation date, modification date, guest permissions, and group
permissions for the new templates.
PortalException - if a portal exception occurredpublic DDMTemplate createDDMTemplate(long templateId)
createDDMTemplate in interface DDMTemplateLocalServicetemplateId - the primary key for the new d d m template
public DDMTemplate deleteDDMTemplate(DDMTemplate ddmTemplate)
deleteDDMTemplate in interface DDMTemplateLocalServiceddmTemplate - the d d m template
public DDMTemplate deleteDDMTemplate(long templateId)
throws PortalException
deleteDDMTemplate in interface DDMTemplateLocalServicetemplateId - the primary key of the d d m template
PortalException - if a d d m template with the primary key could not be found
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException
deletePersistedModel in interface PersistedModelLocalServicedeletePersistedModel in interface DDMTemplateLocalServicePortalException
public void deleteTemplate(DDMTemplate template)
throws PortalException
deleteTemplate in interface DDMTemplateLocalServicetemplate - the template to be deleted
PortalException - if a portal exception occurred
public void deleteTemplate(long templateId)
throws PortalException
deleteTemplate in interface DDMTemplateLocalServicetemplateId - the primary key of the template to be deleted
PortalException - if a portal exception occurred
public void deleteTemplates(long groupId)
throws PortalException
deleteTemplates in interface DDMTemplateLocalServicegroupId - the primary key of the group
PortalException - if a portal exception occurred
public void deleteTemplates(long groupId,
long classNameId)
throws PortalException
deleteTemplates in interface DDMTemplateLocalServicePortalExceptionpublic DynamicQuery dynamicQuery()
dynamicQuery in interface DDMTemplateLocalServicepublic <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery in interface DDMTemplateLocalServicedynamicQuery - the dynamic query
public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portlet.dynamicdatamapping.model.impl.DDMTemplateModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
dynamicQuery in interface DDMTemplateLocalServicedynamicQuery - the dynamic querystart - the lower bound of the range of model instancesend - the upper bound of the range of model instances (not inclusive)
public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator<T> orderByComparator)
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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portlet.dynamicdatamapping.model.impl.DDMTemplateModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
dynamicQuery in interface DDMTemplateLocalServicedynamicQuery - 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 (optionally null)
public long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQueryCount in interface DDMTemplateLocalServicedynamicQuery - the dynamic query
public long dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
dynamicQueryCount in interface DDMTemplateLocalServicedynamicQuery - the dynamic queryprojection - the projection to apply to the query
public DDMTemplate fetchDDMTemplate(long templateId)
fetchDDMTemplate in interface DDMTemplateLocalService
public DDMTemplate fetchDDMTemplateByUuidAndGroupId(String uuid,
long groupId)
fetchDDMTemplateByUuidAndGroupId in interface DDMTemplateLocalServiceuuid - the d d m template's UUIDgroupId - the primary key of the group
null if a matching d d m template could not be found
public DDMTemplate fetchTemplate(long groupId,
long classNameId,
String templateKey)
fetchTemplate in interface DDMTemplateLocalServicegroupId - 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
null if a matching
template could not be found
public DDMTemplate fetchTemplate(long groupId,
long classNameId,
String templateKey,
boolean includeAncestorTemplates)
throws PortalException
This method first searches in the given group. If the template is still
not found and includeAncestorTemplates is set to
true, this method searches the group's ancestor sites (that
have sharing enabled) and lastly searches global scoped sites.
fetchTemplate in interface DDMTemplateLocalServicegroupId - 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
null if a matching
template could not be found
PortalException - if a portal exception occurredpublic ActionableDynamicQuery getActionableDynamicQuery()
getActionableDynamicQuery in interface DDMTemplateLocalServicepublic String getBeanIdentifier()
getBeanIdentifier in interface DDMTemplateLocalService
public DDMTemplate getDDMTemplate(long templateId)
throws PortalException
getDDMTemplate in interface DDMTemplateLocalServicetemplateId - the primary key of the d d m template
PortalException - if a d d m template with the primary key could not be found
public DDMTemplate getDDMTemplateByUuidAndGroupId(String uuid,
long groupId)
throws PortalException
getDDMTemplateByUuidAndGroupId in interface DDMTemplateLocalServiceuuid - the d d m template's UUIDgroupId - the primary key of the group
PortalException - if a matching d d m template could not be found
public List<DDMTemplate> getDDMTemplates(int start,
int end)
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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portlet.dynamicdatamapping.model.impl.DDMTemplateModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
getDDMTemplates in interface DDMTemplateLocalServicestart - the lower bound of the range of d d m templatesend - the upper bound of the range of d d m templates (not inclusive)
public List<DDMTemplate> getDDMTemplatesByUuidAndCompanyId(String uuid,
long companyId)
getDDMTemplatesByUuidAndCompanyId in interface DDMTemplateLocalServiceuuid - the UUID of the d d m templatescompanyId - the primary key of the company
public List<DDMTemplate> getDDMTemplatesByUuidAndCompanyId(String uuid,
long companyId,
int start,
int end,
OrderByComparator<DDMTemplate> orderByComparator)
getDDMTemplatesByUuidAndCompanyId in interface DDMTemplateLocalServiceuuid - the UUID of the d d m templatescompanyId - the primary key of the companystart - the lower bound of the range of d d m templatesend - the upper bound of the range of d d m templates (not inclusive)orderByComparator - the comparator to order the results by (optionally null)
public int getDDMTemplatesCount()
getDDMTemplatesCount in interface DDMTemplateLocalServicepublic ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
getExportActionableDynamicQuery in interface DDMTemplateLocalService
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException
getPersistedModel in interface PersistedModelLocalServicegetPersistedModel in interface DDMTemplateLocalServicePortalException
public DDMTemplate getTemplate(long groupId,
long classNameId,
String templateKey)
throws PortalException
getTemplate in interface DDMTemplateLocalServicegroupId - 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
PortalException - if a matching template could not be found
public DDMTemplate getTemplate(long groupId,
long classNameId,
String templateKey,
boolean includeAncestorTemplates)
throws PortalException
This method first searches in the group. If the template is still not
found and includeAncestorTemplates is set to
true, this method searches the group's ancestor sites (that
have sharing enabled) and lastly searches global scoped sites.
getTemplate in interface DDMTemplateLocalServicegroupId - 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
PortalException - if a matching template could not be found
public DDMTemplate getTemplate(long templateId)
throws PortalException
getTemplate in interface DDMTemplateLocalServicetemplateId - the primary key of the template
PortalException - if a matching template could not be found
public DDMTemplate getTemplateBySmallImageId(long smallImageId)
throws PortalException
getTemplateBySmallImageId in interface DDMTemplateLocalServicePortalExceptionpublic List<DDMTemplate> getTemplates(long classPK)
getTemplates in interface DDMTemplateLocalServiceclassPK - the primary key of the template's related entity
public List<DDMTemplate> getTemplates(long groupId,
long classNameId)
getTemplates in interface DDMTemplateLocalServicegroupId - the primary key of the groupclassNameId - the primary key of the class name for the template's
related model
public List<DDMTemplate> getTemplates(long groupId,
long classNameId,
long classPK)
getTemplates in interface DDMTemplateLocalServicegroupId - 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
public List<DDMTemplate> getTemplates(long groupId,
long classNameId,
long classPK,
boolean includeAncestorTemplates)
throws PortalException
getTemplates in interface DDMTemplateLocalServicePortalException
public List<DDMTemplate> getTemplates(long groupId,
long classNameId,
long classPK,
String type)
getTemplates in interface DDMTemplateLocalServicegroupId - 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.
public List<DDMTemplate> getTemplates(long groupId,
long classNameId,
long classPK,
String type,
String mode)
getTemplates in interface DDMTemplateLocalServicegroupId - 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.mode - the template's mode. For more information, see DDMTemplateConstants.
public List<DDMTemplate> getTemplates(long[] groupIds,
long classNameId,
long classPK)
getTemplates in interface DDMTemplateLocalService
public List<DDMTemplate> getTemplatesByClassPK(long groupId,
long classPK)
getTemplatesByClassPK in interface DDMTemplateLocalService
public List<DDMTemplate> getTemplatesByClassPK(long groupId,
long classPK,
int start,
int end)
getTemplatesByClassPK in interface DDMTemplateLocalService
public List<DDMTemplate> getTemplatesByClassPK(long[] groupIds,
long classPK)
getTemplatesByClassPK in interface DDMTemplateLocalService
public int getTemplatesByClassPKCount(long groupId,
long classPK)
getTemplatesByClassPKCount in interface DDMTemplateLocalServicegroupId - the primary key of the groupclassPK - the primary key of the template's related entity
public List<DDMTemplate> getTemplatesByStructureClassNameId(long groupId,
long structureClassNameId,
int start,
int end,
OrderByComparator<DDMTemplate> orderByComparator)
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 QueryUtil.ALL_POS will return the full
result set.
getTemplatesByStructureClassNameId in interface DDMTemplateLocalServicegroupId - the primary key of the groupstructureClassNameId - the primary key of the class name for the
template's related structurestart - 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
(optionally null)
public int getTemplatesByStructureClassNameIdCount(long groupId,
long structureClassNameId)
getTemplatesByStructureClassNameIdCount in interface DDMTemplateLocalServicegroupId - the primary key of the groupstructureClassNameId - the primary key of the class name for the
template's related structure
public int getTemplatesCount(long groupId)
getTemplatesCount in interface DDMTemplateLocalServicegroupId - the primary key of the group
public int getTemplatesCount(long groupId,
long classNameId)
getTemplatesCount in interface DDMTemplateLocalServicegroupId - the primary key of the groupclassNameId - the primary key of the class name for the template's
related model
public int getTemplatesCount(long groupId,
long classNameId,
long classPK)
getTemplatesCount in interface DDMTemplateLocalServicegroupId - 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
public List<DDMTemplate> search(long companyId,
long groupId,
long classNameId,
long classPK,
String keywords,
String type,
String mode,
int start,
int end,
OrderByComparator<DDMTemplate> orderByComparator)
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 QueryUtil.ALL_POS will return the full
result set.
search in interface DDMTemplateLocalServicecompanyId - 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 entitykeywords - the keywords (space separated), which may occur in the
template's name or description (optionally null)type - the template's type (optionally null). For more
information, see DDMTemplateConstants.mode - the template's mode (optionally null). For more
information, see DDMTemplateConstants.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
(optionally null)
public List<DDMTemplate> search(long companyId,
long groupId,
long classNameId,
long classPK,
String name,
String description,
String type,
String mode,
String language,
boolean andOperator,
int start,
int end,
OrderByComparator<DDMTemplate> orderByComparator)
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 QueryUtil.ALL_POS will return the full
result set.
search in interface DDMTemplateLocalServicecompanyId - 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 entityname - the name keywords (optionally null)description - the description keywords (optionally
null)type - the template's type (optionally null). For more
information, see DDMTemplateConstants.mode - the template's mode (optionally null). For more
information, see DDMTemplateConstants.language - the template's script language (optionally
null). For more information, see DDMTemplateConstants.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
(optionally null)
public List<DDMTemplate> search(long companyId,
long[] groupIds,
long[] classNameIds,
long[] classPKs,
String keywords,
String type,
String mode,
int start,
int end,
OrderByComparator<DDMTemplate> orderByComparator)
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 QueryUtil.ALL_POS will return the full
result set.
search in interface DDMTemplateLocalServicecompanyId - 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 entitieskeywords - the keywords (space separated), which may occur in the
template's name or description (optionally null)type - the template's type (optionally null). For more
information, see DDMTemplateConstants.mode - the template's mode (optionally null). For more
information, see DDMTemplateConstants.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
(optionally null)
public List<DDMTemplate> search(long companyId,
long[] groupIds,
long[] classNameIds,
long[] classPKs,
String name,
String description,
String type,
String mode,
String language,
boolean andOperator,
int start,
int end,
OrderByComparator<DDMTemplate> orderByComparator)
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 QueryUtil.ALL_POS will return the full
result set.
search in interface DDMTemplateLocalServicecompanyId - 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 entitiesname - the name keywords (optionally null)description - the description keywords (optionally
null)type - the template's type (optionally null). For more
information, see DDMTemplateConstants.mode - the template's mode (optionally null). For more
information, see DDMTemplateConstants.language - the template's script language (optionally
null). For more information, see DDMTemplateConstants.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
(optionally null)
public int searchCount(long companyId,
long groupId,
long classNameId,
long classPK,
String keywords,
String type,
String mode)
searchCount in interface DDMTemplateLocalServicecompanyId - 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 entitykeywords - the keywords (space separated), which may occur in the
template's name or description (optionally null)type - the template's type (optionally null). For more
information, see DDMTemplateConstants.mode - the template's mode (optionally null). For more
information, see DDMTemplateConstants.
public int searchCount(long companyId,
long groupId,
long classNameId,
long classPK,
String name,
String description,
String type,
String mode,
String language,
boolean andOperator)
searchCount in interface DDMTemplateLocalServicecompanyId - 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 entityname - the name keywords (optionally null)description - the description keywords (optionally
null)type - the template's type (optionally null). For more
information, see DDMTemplateConstants.mode - the template's mode (optionally null). For more
information, see DDMTemplateConstants.language - the template's script language (optionally
null). For more information, see DDMTemplateConstants.andOperator - whether every field must match its keywords, or just
one field.
public int searchCount(long companyId,
long[] groupIds,
long[] classNameIds,
long[] classPKs,
String keywords,
String type,
String mode)
searchCount in interface DDMTemplateLocalServicecompanyId - 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 entitieskeywords - the keywords (space separated), which may occur in the
template's name or description (optionally null)type - the template's type (optionally null). For more
information, see DDMTemplateConstants.mode - the template's mode (optionally null). For more
information, see DDMTemplateConstants.
public int searchCount(long companyId,
long[] groupIds,
long[] classNameIds,
long[] classPKs,
String name,
String description,
String type,
String mode,
String language,
boolean andOperator)
searchCount in interface DDMTemplateLocalServicecompanyId - 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 entitiesname - the name keywords (optionally null)description - the description keywords (optionally
null)type - the template's type (optionally null). For more
information, see DDMTemplateConstants.mode - the template's mode (optionally null). For more
information, see DDMTemplateConstants.language - the template's script language (optionally
null). For more information, see DDMTemplateConstants.andOperator - whether every field must match its keywords, or just
one field.
public void setBeanIdentifier(String beanIdentifier)
setBeanIdentifier in interface DDMTemplateLocalServicebeanIdentifier - the Spring bean ID for this beanpublic DDMTemplate updateDDMTemplate(DDMTemplate ddmTemplate)
updateDDMTemplate in interface DDMTemplateLocalServiceddmTemplate - the d d m template
public DDMTemplate updateTemplate(long templateId,
long classPK,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String type,
String mode,
String language,
String script,
boolean cacheable,
ServiceContext serviceContext)
throws PortalException
updateTemplate in interface DDMTemplateLocalServicetemplateId - 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.mode - the template's mode. For more information, see DDMTemplateConstants.language - the template's script language. For more information,
see DDMTemplateConstants.script - the template's scriptcacheable - whether the template is cacheableserviceContext - the service context to be applied. Can set the
modification date.
PortalException - if a portal exception occurred
public DDMTemplate updateTemplate(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,
ServiceContext serviceContext)
throws PortalException
updateTemplate in interface DDMTemplateLocalServicetemplateId - 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.mode - the template's mode. For more information, see DDMTemplateConstants.language - the template's script language. For more information,
see DDMTemplateConstants.script - the template's scriptcacheable - whether the template is cacheablesmallImage - whether the template has a small imagesmallImageURL - the template's small image URL (optionally
null)smallImageFile - the template's small image file (optionally
null)serviceContext - the service context to be applied. Can set the
modification date.
PortalException - if a portal exception occurred@Deprecated public DDMTemplateLocalService getWrappedDDMTemplateLocalService()
getWrappedService()
@Deprecated public void setWrappedDDMTemplateLocalService(DDMTemplateLocalService ddmTemplateLocalService)
setWrappedService(com.liferay.portlet.dynamicdatamapping.service.DDMTemplateLocalService)
public DDMTemplateLocalService getWrappedService()
getWrappedService in interface ServiceWrapper<DDMTemplateLocalService>public void setWrappedService(DDMTemplateLocalService ddmTemplateLocalService)
setWrappedService in interface ServiceWrapper<DDMTemplateLocalService>
|
Liferay 7.0-ce-m3 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||