com.liferay.portlet.dynamicdatamapping.service
Class DDMTemplateLocalServiceUtil

java.lang.Object
  com.liferay.portlet.dynamicdatamapping.service.DDMTemplateLocalServiceUtil

public class DDMTemplateLocalServiceUtil
extends Object

The utility for the d d m template local service. This utility wraps DDMTemplateLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:

DDMTemplateLocalService, DDMTemplateLocalServiceBaseImpl, DDMTemplateLocalServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

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 structureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String type, String mode, String language, String script, ServiceContext serviceContext)
static void	addTemplateResources(DDMTemplate template, boolean addGroupPermissions, boolean addGuestPermissions)
static void	addTemplateResources(DDMTemplate template, String[] groupPermissions, String[] guestPermissions)
static List<DDMTemplate>	copyTemplates(long userId, long structureId, long newStructureId, String type, ServiceContext serviceContext)
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 void	deleteTemplate(DDMTemplate template)
static void	deleteTemplate(long templateId)
static void	deleteTemplates(long groupId)
static DynamicQuery	dynamicQuery()
static List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator 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 that match the dynamic query.
static DDMTemplate	fetchDDMTemplate(long templateId)
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 with the UUID in the group.
static List<DDMTemplate>	getDDMTemplates(int start, int end) Returns a range of all the d d m templates.
static int	getDDMTemplatesCount() Returns the number of d d m templates.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static DDMTemplateLocalService	getService()
static DDMTemplate	getTemplate(long templateId)
static List<DDMTemplate>	getTemplates(long structureId)
static List<DDMTemplate>	getTemplates(long structureId, String type)
static List<DDMTemplate>	getTemplates(long structureId, String type, String mode)
static List<DDMTemplate>	search(long companyId, long groupId, long structureId, String keywords, String type, String mode, int start, int end, OrderByComparator orderByComparator)
static List<DDMTemplate>	search(long companyId, long groupId, long structureId, String name, String description, String type, String mode, String language, boolean andOperator, int start, int end, OrderByComparator orderByComparator)
static int	searchCount(long companyId, long groupId, long structureId, String keywords, String type, String mode)
static int	searchCount(long companyId, long groupId, long structureId, String name, String description, String type, String mode, String language, boolean andOperator)
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(DDMTemplateLocalService service) Deprecated.
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	updateDDMTemplate(DDMTemplate ddmTemplate, boolean merge) Updates the d d m template in the database or adds it if it does not yet exist.
static DDMTemplate	updateTemplate(long templateId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String type, String mode, String language, String script, ServiceContext serviceContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

DDMTemplateLocalServiceUtil

public DDMTemplateLocalServiceUtil()

Method Detail

addDDMTemplate

public static DDMTemplate addDDMTemplate(DDMTemplate ddmTemplate)
                                  throws SystemException

Adds the d d m template to the database. Also notifies the appropriate model listeners.

Parameters:

ddmTemplate - the d d m template

Returns:

the d d m template that was added

Throws:

SystemException - if a system exception occurred

createDDMTemplate

public static DDMTemplate createDDMTemplate(long templateId)

Creates a new d d m template with the primary key. Does not add the d d m template to the database.

Parameters:

templateId - the primary key for the new d d m template

Returns:

the new d d m template

deleteDDMTemplate

public static DDMTemplate deleteDDMTemplate(long templateId)
                                     throws PortalException,
                                            SystemException

Deletes the d d m template with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

templateId - the primary key of the d d m template

Returns:

the d d m template that was removed

Throws:

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

SystemException - if a system exception occurred

deleteDDMTemplate

public static DDMTemplate deleteDDMTemplate(DDMTemplate ddmTemplate)
                                     throws SystemException

Deletes the d d m template from the database. Also notifies the appropriate model listeners.

Parameters:

ddmTemplate - the d d m template

Returns:

the d d m template that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException

Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException

Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchDDMTemplate

public static DDMTemplate fetchDDMTemplate(long templateId)
                                    throws SystemException

Throws:

SystemException

getDDMTemplate

public static DDMTemplate getDDMTemplate(long templateId)
                                  throws PortalException,
                                         SystemException

Returns the d d m template with the primary key.

Parameters:

templateId - the primary key of the d d m template

Returns:

the d d m template

Throws:

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

SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getDDMTemplateByUuidAndGroupId

public static DDMTemplate getDDMTemplateByUuidAndGroupId(String uuid,
                                                         long groupId)
                                                  throws PortalException,
                                                         SystemException

Returns the d d m template with the UUID in the group.

Parameters:

uuid - the UUID of d d m template

groupId - the group id of the d d m template

Returns:

the d d m template

Throws:

PortalException - if a d d m template with the UUID in the group could not be found

SystemException - if a system exception occurred

getDDMTemplates

public static List<DDMTemplate> getDDMTemplates(int start,
                                                int end)
                                         throws SystemException

Returns a range of all the d d m templates.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

start - the lower bound of the range of d d m templates

end - the upper bound of the range of d d m templates (not inclusive)

Returns:

the range of d d m templates

Throws:

SystemException - if a system exception occurred

getDDMTemplatesCount

public static int getDDMTemplatesCount()
                                throws SystemException

Returns the number of d d m templates.

Returns:

the number of d d m templates

Throws:

SystemException - if a system exception occurred

updateDDMTemplate

public static DDMTemplate updateDDMTemplate(DDMTemplate ddmTemplate)
                                     throws SystemException

Updates the d d m template in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

ddmTemplate - the d d m template

Returns:

the d d m template that was updated

Throws:

SystemException - if a system exception occurred

updateDDMTemplate

public static DDMTemplate updateDDMTemplate(DDMTemplate ddmTemplate,
                                            boolean merge)
                                     throws SystemException

Updates the d d m template in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

ddmTemplate - the d d m template

merge - whether to merge the d d m template with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the d d m template that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addTemplate

public static DDMTemplate addTemplate(long userId,
                                      long groupId,
                                      long structureId,
                                      Map<Locale,String> nameMap,
                                      Map<Locale,String> descriptionMap,
                                      String type,
                                      String mode,
                                      String language,
                                      String script,
                                      ServiceContext serviceContext)
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

addTemplateResources

public static void addTemplateResources(DDMTemplate template,
                                        boolean addGroupPermissions,
                                        boolean addGuestPermissions)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

addTemplateResources

public static void addTemplateResources(DDMTemplate template,
                                        String[] groupPermissions,
                                        String[] guestPermissions)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

copyTemplates

public static List<DDMTemplate> copyTemplates(long userId,
                                              long structureId,
                                              long newStructureId,
                                              String type,
                                              ServiceContext serviceContext)
                                       throws PortalException,
                                              SystemException

Throws:

PortalException

SystemException

deleteTemplate

public static void deleteTemplate(DDMTemplate template)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

deleteTemplate

public static void deleteTemplate(long templateId)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

deleteTemplates

public static void deleteTemplates(long groupId)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

getTemplate

public static DDMTemplate getTemplate(long templateId)
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

getTemplates

public static List<DDMTemplate> getTemplates(long structureId)
                                      throws SystemException

Throws:

SystemException

getTemplates

public static List<DDMTemplate> getTemplates(long structureId,
                                             String type)
                                      throws SystemException

Throws:

SystemException

getTemplates

public static List<DDMTemplate> getTemplates(long structureId,
                                             String type,
                                             String mode)
                                      throws SystemException

Throws:

SystemException

search

public static List<DDMTemplate> search(long companyId,
                                       long groupId,
                                       long structureId,
                                       String keywords,
                                       String type,
                                       String mode,
                                       int start,
                                       int end,
                                       OrderByComparator orderByComparator)
                                throws SystemException

Throws:

SystemException

search

public static List<DDMTemplate> search(long companyId,
                                       long groupId,
                                       long structureId,
                                       String name,
                                       String description,
                                       String type,
                                       String mode,
                                       String language,
                                       boolean andOperator,
                                       int start,
                                       int end,
                                       OrderByComparator orderByComparator)
                                throws SystemException

Throws:

SystemException

searchCount

public static int searchCount(long companyId,
                              long groupId,
                              long structureId,
                              String keywords,
                              String type,
                              String mode)
                       throws SystemException

Throws:

SystemException

searchCount

public static int searchCount(long companyId,
                              long groupId,
                              long structureId,
                              String name,
                              String description,
                              String type,
                              String mode,
                              String language,
                              boolean andOperator)
                       throws SystemException

Throws:

SystemException

updateTemplate

public static DDMTemplate updateTemplate(long templateId,
                                         Map<Locale,String> nameMap,
                                         Map<Locale,String> descriptionMap,
                                         String type,
                                         String mode,
                                         String language,
                                         String script,
                                         ServiceContext serviceContext)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

getService

public static DDMTemplateLocalService getService()

setService

public void setService(DDMTemplateLocalService service)

Deprecated.