Liferay 6.2.0-ce-m3

com.liferay.portlet.dynamicdatamapping.service
Interface DDMStructureService

All Superinterfaces:
BaseService
All Known Implementing Classes:
DDMStructureServiceBaseImpl, DDMStructureServiceImpl, DDMStructureServiceWrapper

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

The interface for the d d m structure remote service.

This is a remote service. 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:
DDMStructureServiceUtil, DDMStructureServiceBaseImpl, DDMStructureServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 DDMStructure addStructure(long userId, long groupId, long classNameId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsd, ServiceContext serviceContext)
           
 DDMStructure addStructure(long groupId, long parentStructureId, long classNameId, String structureKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsd, String storageType, int type, ServiceContext serviceContext)
           
 DDMStructure addStructure(long userId, long groupId, String parentStructureKey, long classNameId, String structureKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsd, String storageType, int type, ServiceContext serviceContext)
           
 DDMStructure copyStructure(long structureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, ServiceContext serviceContext)
           
 void deleteStructure(long structureId)
           
 DDMStructure fetchStructure(long groupId, String structureKey)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 DDMStructure getStructure(long structureId)
           
 DDMStructure getStructure(long groupId, String structureKey)
           
 DDMStructure getStructure(long groupId, String structureKey, boolean includeGlobalStructures)
           
 List<DDMStructure> getStructures(long groupId)
           
 List<DDMStructure> getStructures(long[] groupIds)
           
 List<DDMStructure> search(long companyId, long[] groupIds, long[] classNameIds, String keywords, int start, int end, OrderByComparator orderByComparator)
           
 List<DDMStructure> search(long companyId, long[] groupIds, long[] classNameIds, String name, String description, String storageType, int type, boolean andOperator, int start, int end, OrderByComparator orderByComparator)
           
 int searchCount(long companyId, long[] groupIds, long[] classNameIds, String keywords)
           
 int searchCount(long companyId, long[] groupIds, long[] classNameIds, String name, String description, String storageType, int type, boolean andOperator)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 DDMStructure updateStructure(long structureId, long parentStructureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsd, ServiceContext serviceContext)
           
 DDMStructure updateStructure(long groupId, long parentStructureId, String structureKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsd, ServiceContext serviceContext)
           
 

Method Detail

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addStructure

DDMStructure addStructure(long userId,
                          long groupId,
                          String parentStructureKey,
                          long classNameId,
                          String structureKey,
                          Map<Locale,String> nameMap,
                          Map<Locale,String> descriptionMap,
                          String xsd,
                          String storageType,
                          int type,
                          ServiceContext serviceContext)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

addStructure

DDMStructure addStructure(long userId,
                          long groupId,
                          long classNameId,
                          Map<Locale,String> nameMap,
                          Map<Locale,String> descriptionMap,
                          String xsd,
                          ServiceContext serviceContext)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

addStructure

DDMStructure addStructure(long groupId,
                          long parentStructureId,
                          long classNameId,
                          String structureKey,
                          Map<Locale,String> nameMap,
                          Map<Locale,String> descriptionMap,
                          String xsd,
                          String storageType,
                          int type,
                          ServiceContext serviceContext)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

copyStructure

DDMStructure copyStructure(long structureId,
                           Map<Locale,String> nameMap,
                           Map<Locale,String> descriptionMap,
                           ServiceContext serviceContext)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

deleteStructure

void deleteStructure(long structureId)
                     throws PortalException,
                            SystemException
Throws:
PortalException
SystemException

fetchStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructure fetchStructure(long groupId,
                                                                     String structureKey)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

getStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructure getStructure(long structureId)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

getStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructure getStructure(long groupId,
                                                                   String structureKey)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

getStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructure getStructure(long groupId,
                                                                   String structureKey,
                                                                   boolean includeGlobalStructures)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

getStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getStructures(long groupId)
                                 throws SystemException
Throws:
SystemException

getStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getStructures(long[] groupIds)
                                 throws SystemException
Throws:
SystemException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> search(long companyId,
                                                                   long[] groupIds,
                                                                   long[] classNameIds,
                                                                   String keywords,
                                                                   int start,
                                                                   int end,
                                                                   OrderByComparator orderByComparator)
                          throws SystemException
Throws:
SystemException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> search(long companyId,
                                                                   long[] groupIds,
                                                                   long[] classNameIds,
                                                                   String name,
                                                                   String description,
                                                                   String storageType,
                                                                   int type,
                                                                   boolean andOperator,
                                                                   int start,
                                                                   int end,
                                                                   OrderByComparator orderByComparator)
                          throws SystemException
Throws:
SystemException

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                         long[] groupIds,
                                                         long[] classNameIds,
                                                         String keywords)
                throws SystemException
Throws:
SystemException

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                         long[] groupIds,
                                                         long[] classNameIds,
                                                         String name,
                                                         String description,
                                                         String storageType,
                                                         int type,
                                                         boolean andOperator)
                throws SystemException
Throws:
SystemException

updateStructure

DDMStructure updateStructure(long structureId,
                             long parentStructureId,
                             Map<Locale,String> nameMap,
                             Map<Locale,String> descriptionMap,
                             String xsd,
                             ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

updateStructure

DDMStructure updateStructure(long groupId,
                             long parentStructureId,
                             String structureKey,
                             Map<Locale,String> nameMap,
                             Map<Locale,String> descriptionMap,
                             String xsd,
                             ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

Liferay 6.2.0-ce-m3