|
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.DDMTemplateLocalServiceUtil
@ProviderType public class DDMTemplateLocalServiceUtil
Provides the local service utility for DDMTemplate. This utility wraps
DDMTemplateLocalServiceImpl and is the
primary access point for service operations in application layer code running
on the local server. Methods of this service will not have security checks
based on the propagated JAAS credentials because this service can only be
accessed from within the same VM.
DDMTemplateLocalService,
DDMTemplateLocalServiceBaseImpl,
DDMTemplateLocalServiceImpl| Constructor Summary | |
|---|---|
DDMTemplateLocalServiceUtil()
|
|
| Method Summary | ||
|---|---|---|
static DDMTemplate |
addDDMTemplate(DDMTemplate ddmTemplate)
Adds the d d m template to the database. |
|
static 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. |
|
static 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. |
|
static void |
addTemplateResources(DDMTemplate template,
boolean addGroupPermissions,
boolean addGuestPermissions)
Adds the resources to the template. |
|
static void |
addTemplateResources(DDMTemplate template,
String[] groupPermissions,
String[] guestPermissions)
Adds the model resources with the permissions to the template. |
|
static 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. |
|
static DDMTemplate |
copyTemplate(long userId,
long templateId,
ServiceContext serviceContext)
|
|
static 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. |
|
static DDMTemplate |
createDDMTemplate(long templateId)
Creates a new d d m template with the primary key. |
|
static DDMTemplate |
deleteDDMTemplate(DDMTemplate ddmTemplate)
Deletes the d d m template from the database. |
|
static DDMTemplate |
deleteDDMTemplate(long templateId)
Deletes the d d m template with the primary key from the database. |
|
static PersistedModel |
deletePersistedModel(PersistedModel persistedModel)
|
|
static void |
deleteTemplate(DDMTemplate template)
Deletes the template and its resources. |
|
static void |
deleteTemplate(long templateId)
Deletes the template and its resources. |
|
static void |
deleteTemplates(long groupId)
Deletes all the templates of the group. |
|
static void |
deleteTemplates(long groupId,
long classNameId)
|
|
static DynamicQuery |
dynamicQuery()
|
|
static
|
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
|
static
|
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
|
static
|
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator<T> orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows. |
|
static long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query. |
|
static long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows matching the dynamic query. |
|
static DDMTemplate |
fetchDDMTemplate(long templateId)
|
|
static DDMTemplate |
fetchDDMTemplateByUuidAndGroupId(String uuid,
long groupId)
Returns the d d m template matching the UUID and group. |
|
static DDMTemplate |
fetchTemplate(long groupId,
long classNameId,
String templateKey)
Returns the template matching the group and template key. |
|
static 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. |
|
static ActionableDynamicQuery |
getActionableDynamicQuery()
|
|
static String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
|
static DDMTemplate |
getDDMTemplate(long templateId)
Returns the d d m template with the primary key. |
|
static DDMTemplate |
getDDMTemplateByUuidAndGroupId(String uuid,
long groupId)
Returns the d d m template matching the UUID and group. |
|
static List<DDMTemplate> |
getDDMTemplates(int start,
int end)
Returns a range of all the d d m templates. |
|
static List<DDMTemplate> |
getDDMTemplatesByUuidAndCompanyId(String uuid,
long companyId)
Returns all the d d m templates matching the UUID and company. |
|
static 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. |
|
static int |
getDDMTemplatesCount()
Returns the number of d d m templates. |
|
static ExportActionableDynamicQuery |
getExportActionableDynamicQuery(PortletDataContext portletDataContext)
|
|
static PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
|
static DDMTemplateLocalService |
getService()
|
|
static DDMTemplate |
getTemplate(long templateId)
Returns the template with the ID. |
|
static DDMTemplate |
getTemplate(long groupId,
long classNameId,
String templateKey)
Returns the template matching the group and template key. |
|
static 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. |
|
static DDMTemplate |
getTemplateBySmallImageId(long smallImageId)
|
|
static List<DDMTemplate> |
getTemplates(long classPK)
Returns all the templates with the class PK. |
|
static List<DDMTemplate> |
getTemplates(long[] groupIds,
long classNameId,
long classPK)
|
|
static List<DDMTemplate> |
getTemplates(long groupId,
long classNameId)
Returns all the templates matching the group and class name ID. |
|
static List<DDMTemplate> |
getTemplates(long groupId,
long classNameId,
long classPK)
Returns all the templates matching the group, class name ID, and class PK. |
|
static List<DDMTemplate> |
getTemplates(long groupId,
long classNameId,
long classPK,
boolean includeAncestorTemplates)
|
|
static 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. |
|
static 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. |
|
static List<DDMTemplate> |
getTemplatesByClassPK(long[] groupIds,
long classPK)
|
|
static List<DDMTemplate> |
getTemplatesByClassPK(long groupId,
long classPK)
|
|
static List<DDMTemplate> |
getTemplatesByClassPK(long groupId,
long classPK,
int start,
int end)
|
|
static int |
getTemplatesByClassPKCount(long groupId,
long classPK)
Returns the number of templates matching the group and class PK. |
|
static 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. |
|
static int |
getTemplatesByStructureClassNameIdCount(long groupId,
long structureClassNameId)
Returns the number of templates matching the group and structure class name ID, including Generic Templates. |
|
static int |
getTemplatesCount(long groupId)
Returns the number of templates belonging to the group. |
|
static int |
getTemplatesCount(long groupId,
long classNameId)
Returns the number of templates matching the group and class name ID. |
|
static int |
getTemplatesCount(long groupId,
long classNameId,
long classPK)
Returns the number of templates matching the group, class name ID, and class PK. |
|
static 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. |
|
static 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. |
|
static 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. |
|
static 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. |
|
static 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. |
|
static 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. |
|
static 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. |
|
static 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. |
|
static void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
|
void |
setService(DDMTemplateLocalService service)
Deprecated. As of 6.2.0 |
|
static DDMTemplate |
updateDDMTemplate(DDMTemplate ddmTemplate)
Updates the d d m template in the database or adds it if it does not yet exist. |
|
static 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. |
|
static 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 DDMTemplateLocalServiceUtil()
| Method Detail |
|---|
public static DDMTemplate addDDMTemplate(DDMTemplate ddmTemplate)
ddmTemplate - the d d m template
public static 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
userId - 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 static 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
userId - 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 static void addTemplateResources(DDMTemplate template,
boolean addGroupPermissions,
boolean addGuestPermissions)
throws PortalException
template - the template to add resources toaddGroupPermissions - whether to add group permissionsaddGuestPermissions - whether to add guest permissions
PortalException - if a portal exception occurred
public static void addTemplateResources(DDMTemplate template,
String[] groupPermissions,
String[] guestPermissions)
throws PortalException
template - 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 static DDMTemplate copyTemplate(long userId,
long templateId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
ServiceContext serviceContext)
throws PortalException
userId - 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 static DDMTemplate copyTemplate(long userId,
long templateId,
ServiceContext serviceContext)
throws PortalException
PortalException
public static List<DDMTemplate> copyTemplates(long userId,
long classNameId,
long oldClassPK,
long newClassPK,
String type,
ServiceContext serviceContext)
throws PortalException
userId - 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 static DDMTemplate createDDMTemplate(long templateId)
templateId - the primary key for the new d d m template
public static DDMTemplate deleteDDMTemplate(DDMTemplate ddmTemplate)
ddmTemplate - the d d m template
public static DDMTemplate deleteDDMTemplate(long templateId)
throws PortalException
templateId - 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 static PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException
PortalException
public static void deleteTemplate(DDMTemplate template)
throws PortalException
template - the template to be deleted
PortalException - if a portal exception occurred
public static void deleteTemplate(long templateId)
throws PortalException
templateId - the primary key of the template to be deleted
PortalException - if a portal exception occurred
public static void deleteTemplates(long groupId)
throws PortalException
groupId - the primary key of the group
PortalException - if a portal exception occurred
public static void deleteTemplates(long groupId,
long classNameId)
throws PortalException
PortalExceptionpublic static DynamicQuery dynamicQuery()
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query
public static <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 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 - the dynamic querystart - the lower bound of the range of model instancesend - the upper bound of the range of model instances (not inclusive)
public static <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 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 - 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 static long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query
public static long dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
dynamicQuery - the dynamic queryprojection - the projection to apply to the query
public static DDMTemplate fetchDDMTemplate(long templateId)
public static DDMTemplate fetchDDMTemplateByUuidAndGroupId(String uuid,
long groupId)
uuid - 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 static DDMTemplate fetchTemplate(long groupId,
long classNameId,
String templateKey)
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
null if a matching
template could not be found
public static 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.
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
null if a matching
template could not be found
PortalException - if a portal exception occurredpublic static ActionableDynamicQuery getActionableDynamicQuery()
public static String getBeanIdentifier()
public static DDMTemplate getDDMTemplate(long templateId)
throws PortalException
templateId - 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 static DDMTemplate getDDMTemplateByUuidAndGroupId(String uuid,
long groupId)
throws PortalException
uuid - 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 static 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 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.
start - 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 static List<DDMTemplate> getDDMTemplatesByUuidAndCompanyId(String uuid,
long companyId)
uuid - the UUID of the d d m templatescompanyId - the primary key of the company
public static List<DDMTemplate> getDDMTemplatesByUuidAndCompanyId(String uuid,
long companyId,
int start,
int end,
OrderByComparator<DDMTemplate> orderByComparator)
uuid - 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 static int getDDMTemplatesCount()
public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException
PortalException
public static DDMTemplate getTemplate(long groupId,
long classNameId,
String templateKey)
throws PortalException
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
PortalException - if a matching template could not be found
public static 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.
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
PortalException - if a matching template could not be found
public static DDMTemplate getTemplate(long templateId)
throws PortalException
templateId - the primary key of the template
PortalException - if a matching template could not be found
public static DDMTemplate getTemplateBySmallImageId(long smallImageId)
throws PortalException
PortalExceptionpublic static List<DDMTemplate> getTemplates(long classPK)
classPK - the primary key of the template's related entity
public static List<DDMTemplate> getTemplates(long groupId,
long classNameId)
groupId - the primary key of the groupclassNameId - the primary key of the class name for the template's
related model
public static List<DDMTemplate> getTemplates(long groupId,
long classNameId,
long classPK)
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
public static List<DDMTemplate> getTemplates(long groupId,
long classNameId,
long classPK,
boolean includeAncestorTemplates)
throws PortalException
PortalException
public static List<DDMTemplate> getTemplates(long groupId,
long classNameId,
long classPK,
String type)
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.
public static List<DDMTemplate> getTemplates(long groupId,
long classNameId,
long classPK,
String type,
String mode)
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.mode - the template's mode. For more information, see DDMTemplateConstants.
public static List<DDMTemplate> getTemplates(long[] groupIds,
long classNameId,
long classPK)
public static List<DDMTemplate> getTemplatesByClassPK(long groupId,
long classPK)
public static List<DDMTemplate> getTemplatesByClassPK(long groupId,
long classPK,
int start,
int end)
public static List<DDMTemplate> getTemplatesByClassPK(long[] groupIds,
long classPK)
public static int getTemplatesByClassPKCount(long groupId,
long classPK)
groupId - the primary key of the groupclassPK - the primary key of the template's related entity
public static 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.
groupId - 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 static int getTemplatesByStructureClassNameIdCount(long groupId,
long structureClassNameId)
groupId - the primary key of the groupstructureClassNameId - the primary key of the class name for the
template's related structure
public static int getTemplatesCount(long groupId)
groupId - the primary key of the group
public static int getTemplatesCount(long groupId,
long classNameId)
groupId - the primary key of the groupclassNameId - the primary key of the class name for the template's
related model
public static int getTemplatesCount(long groupId,
long classNameId,
long classPK)
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
public static 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.
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 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 static 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.
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 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 static 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.
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 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 static 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.
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 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 static int searchCount(long companyId,
long groupId,
long classNameId,
long classPK,
String keywords,
String type,
String mode)
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 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 static int searchCount(long companyId,
long groupId,
long classNameId,
long classPK,
String name,
String description,
String type,
String mode,
String language,
boolean andOperator)
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 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 static int searchCount(long companyId,
long[] groupIds,
long[] classNameIds,
long[] classPKs,
String keywords,
String type,
String mode)
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 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 static int searchCount(long companyId,
long[] groupIds,
long[] classNameIds,
long[] classPKs,
String name,
String description,
String type,
String mode,
String language,
boolean andOperator)
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 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 static void setBeanIdentifier(String beanIdentifier)
beanIdentifier - the Spring bean ID for this beanpublic static DDMTemplate updateDDMTemplate(DDMTemplate ddmTemplate)
ddmTemplate - the d d m template
public static 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
templateId - 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 static 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
templateId - 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 occurredpublic static DDMTemplateLocalService getService()
@Deprecated public void setService(DDMTemplateLocalService service)
|
Liferay 7.0-ce-m3 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||