com.liferay.dynamic.data.mapping.service

Class DDMFormInstanceServiceUtil

java.lang.Object

com.liferay.dynamic.data.mapping.service.DDMFormInstanceServiceUtil

public class DDMFormInstanceServiceUtil
extends java.lang.Object

Provides the remote service utility for DDMFormInstance. This utility wraps com.liferay.dynamic.data.mapping.service.impl.DDMFormInstanceServiceImpl and is an access point for service operations in application layer code running on a remote server. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

See Also:

DDMFormInstanceService

Constructor Summary

Constructors

Constructor and Description
DDMFormInstanceServiceUtil()

Method Summary

Modifier and Type	Method and Description
static DDMFormInstance	addFormInstance(long groupId, long ddmStructureId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, DDMFormValues settingsDDMFormValues, ServiceContext serviceContext)
static DDMFormInstance	addFormInstance(long groupId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, DDMForm ddmForm, DDMFormLayout ddmFormLayout, DDMFormValues settingsDDMFormValues, ServiceContext serviceContext)
static void	deleteFormInstance(long ddmFormInstanceId)
static DDMFormInstance	fetchFormInstance(long ddmFormInstanceId)
static DDMFormInstance	getFormInstance(long ddmFormInstanceId)
static java.util.List<DDMFormInstance>	getFormInstances(long companyId, long groupId, int start, int end)
static int	getFormInstancesCount(long companyId, long groupId)
static int	getFormInstancesCount(java.lang.String uuid)
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static DDMFormInstanceService	getService()
static java.util.List<DDMFormInstance>	search(long companyId, long groupId, java.lang.String[] names, java.lang.String[] descriptions, boolean andOperator, int start, int end, OrderByComparator<DDMFormInstance> orderByComparator)
static java.util.List<DDMFormInstance>	search(long companyId, long groupId, java.lang.String keywords, int start, int end, OrderByComparator<DDMFormInstance> orderByComparator)
static int	searchCount(long companyId, long groupId, java.lang.String keywords)
static int	searchCount(long companyId, long groupId, java.lang.String[] names, java.lang.String[] descriptions, boolean andOperator)
static void	sendEmail(long formInstanceId, java.lang.String message, java.lang.String subject, java.lang.String[] toEmailAddresses)
static DDMFormInstance	updateFormInstance(long formInstanceId, DDMFormValues settingsDDMFormValues) Updates the the record set's settings.
static DDMFormInstance	updateFormInstance(long ddmFormInstanceId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, DDMForm ddmForm, DDMFormLayout ddmFormLayout, DDMFormValues settingsDDMFormValues, ServiceContext serviceContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

DDMFormInstanceServiceUtil

public DDMFormInstanceServiceUtil()

Method Detail

addFormInstance

public static DDMFormInstance addFormInstance(long groupId,
                                              long ddmStructureId,
                                              java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                              java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                              DDMFormValues settingsDDMFormValues,
                                              ServiceContext serviceContext)
                                       throws PortalException

Throws:

PortalException

addFormInstance

public static DDMFormInstance addFormInstance(long groupId,
                                              java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                              java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                              DDMForm ddmForm,
                                              DDMFormLayout ddmFormLayout,
                                              DDMFormValues settingsDDMFormValues,
                                              ServiceContext serviceContext)
                                       throws PortalException

Throws:

PortalException

deleteFormInstance

public static void deleteFormInstance(long ddmFormInstanceId)
                               throws PortalException

Throws:

PortalException

fetchFormInstance

public static DDMFormInstance fetchFormInstance(long ddmFormInstanceId)
                                         throws PortalException

Throws:

PortalException

getFormInstance

public static DDMFormInstance getFormInstance(long ddmFormInstanceId)
                                       throws PortalException

Throws:

PortalException

getFormInstances

public static java.util.List<DDMFormInstance> getFormInstances(long companyId,
                                                               long groupId,
                                                               int start,
                                                               int end)

getFormInstancesCount

public static int getFormInstancesCount(long companyId,
                                        long groupId)

getFormInstancesCount

public static int getFormInstancesCount(java.lang.String uuid)
                                 throws PortalException

Throws:

PortalException

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

search

public static java.util.List<DDMFormInstance> search(long companyId,
                                                     long groupId,
                                                     java.lang.String keywords,
                                                     int start,
                                                     int end,
                                                     OrderByComparator<DDMFormInstance> orderByComparator)

search

public static java.util.List<DDMFormInstance> search(long companyId,
                                                     long groupId,
                                                     java.lang.String[] names,
                                                     java.lang.String[] descriptions,
                                                     boolean andOperator,
                                                     int start,
                                                     int end,
                                                     OrderByComparator<DDMFormInstance> orderByComparator)

searchCount

public static int searchCount(long companyId,
                              long groupId,
                              java.lang.String keywords)

searchCount

public static int searchCount(long companyId,
                              long groupId,
                              java.lang.String[] names,
                              java.lang.String[] descriptions,
                              boolean andOperator)

sendEmail

public static void sendEmail(long formInstanceId,
                             java.lang.String message,
                             java.lang.String subject,
                             java.lang.String[] toEmailAddresses)
                      throws java.lang.Exception

Throws:

java.lang.Exception

updateFormInstance

public static DDMFormInstance updateFormInstance(long formInstanceId,
                                                 DDMFormValues settingsDDMFormValues)
                                          throws PortalException

Updates the the record set's settings.

Parameters:

formInstanceId - the primary key of the form instance

settingsDDMFormValues - the record set's settings. For more information see DDMFormValues in the dynamic.data.mapping.api module.

Returns:

the record set

Throws:

PortalException - if a portal exception occurred

updateFormInstance

public static DDMFormInstance updateFormInstance(long ddmFormInstanceId,
                                                 java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                                 java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                                 DDMForm ddmForm,
                                                 DDMFormLayout ddmFormLayout,
                                                 DDMFormValues settingsDDMFormValues,
                                                 ServiceContext serviceContext)
                                          throws PortalException

Throws:

PortalException

getService

public static DDMFormInstanceService getService()