com.liferay.dynamic.data.mapping.service

Interface DDMFormInstanceService

All Superinterfaces:

BaseService

All Known Implementing Classes:

DDMFormInstanceServiceWrapper

@AccessControlled
 @JSONWebService
 @ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface DDMFormInstanceService
extends BaseService

Provides the remote service interface for DDMFormInstance. 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:

DDMFormInstanceServiceUtil

Method Summary

Modifier and Type	Method and Description
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)
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)
void	deleteFormInstance(long ddmFormInstanceId)
DDMFormInstance	fetchFormInstance(long ddmFormInstanceId)
DDMFormInstance	getFormInstance(long ddmFormInstanceId)
java.util.List<DDMFormInstance>	getFormInstances(long companyId, long groupId, int start, int end)
int	getFormInstancesCount(long companyId, long groupId)
int	getFormInstancesCount(java.lang.String uuid)
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
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)
java.util.List<DDMFormInstance>	search(long companyId, long groupId, java.lang.String keywords, int start, int end, OrderByComparator<DDMFormInstance> orderByComparator)
int	searchCount(long companyId, long groupId, java.lang.String keywords)
int	searchCount(long companyId, long groupId, java.lang.String[] names, java.lang.String[] descriptions, boolean andOperator)
void	sendEmail(long formInstanceId, java.lang.String message, java.lang.String subject, java.lang.String[] toEmailAddresses)
DDMFormInstance	updateFormInstance(long formInstanceId, DDMFormValues settingsDDMFormValues) Updates the the record set's settings.
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)

Method Detail

addFormInstance

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

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

void deleteFormInstance(long ddmFormInstanceId)
                 throws PortalException

Throws:

PortalException

fetchFormInstance

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMFormInstance fetchFormInstance(long ddmFormInstanceId)
                                                                                              throws PortalException

Throws:

PortalException

getFormInstance

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMFormInstance getFormInstance(long ddmFormInstanceId)
                                                                                            throws PortalException

Throws:

PortalException

getFormInstances

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMFormInstance> getFormInstances(long companyId,
                                                                                                                    long groupId,
                                                                                                                    int start,
                                                                                                                    int end)

getFormInstancesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFormInstancesCount(long companyId,
                                                                                             long groupId)

getFormInstancesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFormInstancesCount(java.lang.String uuid)
                                                                                      throws PortalException

Throws:

PortalException

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMFormInstance> search(long companyId,
                                                                                                          long groupId,
                                                                                                          java.lang.String keywords,
                                                                                                          int start,
                                                                                                          int end,
                                                                                                          OrderByComparator<DDMFormInstance> orderByComparator)

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                                                   long groupId,
                                                                                   java.lang.String keywords)

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                                                   long groupId,
                                                                                   java.lang.String[] names,
                                                                                   java.lang.String[] descriptions,
                                                                                   boolean andOperator)

sendEmail

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

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

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