com.liferay.portlet.dynamicdatamapping.service

Interface DDMStructureService

All Superinterfaces:

BaseService

All Known Implementing Classes:

DDMStructureServiceWrapper

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

Provides the remote service interface for DDMStructure. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

Author:

Brian Wing Shun Chan

See Also:

DDMStructureServiceUtil, com.liferay.portlet.dynamicdatamapping.service.base.DDMStructureServiceBaseImpl, com.liferay.portlet.dynamicdatamapping.service.impl.DDMStructureServiceImpl

Generated:

Method Summary

Methods

Modifier and Type	Method and Description
DDMStructure	addStructure(long userId, long groupId, long classNameId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String xsd, ServiceContext serviceContext) Adds a structure referencing a default parent structure, using the portal property dynamic.data.lists.storage.type storage type and default structure type.
DDMStructure	addStructure(long groupId, long parentStructureId, long classNameId, java.lang.String structureKey, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String xsd, java.lang.String storageType, int type, ServiceContext serviceContext) Adds a structure referencing its parent structure.
DDMStructure	addStructure(long userId, long groupId, java.lang.String parentStructureKey, long classNameId, java.lang.String structureKey, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String xsd, java.lang.String storageType, int type, ServiceContext serviceContext) Adds a structure referencing the parent structure by its structure key.
DDMStructure	copyStructure(long structureId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, ServiceContext serviceContext) Copies a structure, creating a new structure with all the values extracted from the original one.
DDMStructure	copyStructure(long structureId, ServiceContext serviceContext)
void	deleteStructure(long structureId) Deletes the structure and its resources.
DDMStructure	fetchStructure(long groupId, long classNameId, java.lang.String structureKey) Returns the structure matching the class name ID, structure key, and group.
java.lang.String	getBeanIdentifier() Returns the Spring bean ID for this bean.
DDMStructure	getStructure(long structureId) Returns the structure with the ID.
DDMStructure	getStructure(long groupId, long classNameId, java.lang.String structureKey) Returns the structure matching the class name ID, structure key, and group.
DDMStructure	getStructure(long groupId, long classNameId, java.lang.String structureKey, boolean includeGlobalStructures) Returns the structure matching the class name ID, structure key, and group, optionally in the global scope.
java.util.List<DDMStructure>	getStructures(long groupId) Returns all the structures in the group that the user has permission to view.
java.util.List<DDMStructure>	getStructures(long[] groupIds) Returns all the structures in the groups that the user has permission to view.
java.util.List<DDMStructure>	getStructures(long[] groupIds, long classNameId)
java.util.List<DDMStructure>	getStructures(long[] groupIds, long classNameId, int start, int end)
java.util.List<DDMStructure>	search(long companyId, long[] groupIds, long[] classNameIds, java.lang.String keywords, int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the structures matching the groups and class name IDs, and matching the keywords in the structure names and descriptions.
java.util.List<DDMStructure>	search(long companyId, long[] groupIds, long[] classNameIds, java.lang.String name, java.lang.String description, java.lang.String storageType, int type, boolean andOperator, int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the structures matching the groups, class name IDs, name keyword, description keyword, storage type, and type.
int	searchCount(long companyId, long[] groupIds, long[] classNameIds, java.lang.String keywords) Returns the number of structures matching the groups and class name IDs, and matching the keywords in the structure names and descriptions.
int	searchCount(long companyId, long[] groupIds, long[] classNameIds, java.lang.String name, java.lang.String description, java.lang.String storageType, int type, boolean andOperator) Returns the number of structures matching the groups, class name IDs, name keyword, description keyword, storage type, and type
void	setBeanIdentifier(java.lang.String beanIdentifier) Sets the Spring bean ID for this bean.
DDMStructure	updateStructure(long groupId, long parentStructureId, long classNameId, java.lang.String structureKey, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String xsd, ServiceContext serviceContext) Updates the structure matching the class name ID, structure key, and group, replacing its old parent structure, name map, description map, and XSD with new ones.
DDMStructure	updateStructure(long structureId, long parentStructureId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String xsd, ServiceContext serviceContext) Updates the structure matching the structure ID, replacing the old parent structure ID, name map, description map, and XSD with the new values.

Method Detail

getBeanIdentifier

java.lang.String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(java.lang.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,
                        long classNameId,
                        java.util.Map<java.util.Locale,java.lang.String> nameMap,
                        java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                        java.lang.String xsd,
                        ServiceContext serviceContext)
                          throws PortalException,
                                 SystemException

Adds a structure referencing a default parent structure, using the portal property dynamic.data.lists.storage.type storage type and default structure type.

Parameters:

userId - the primary key of the structure's creator/owner

groupId - the primary key of the group

classNameId - the primary key of the class name for the structure's related model

nameMap - the structure's locales and localized names

descriptionMap - the structure's locales and localized descriptions

xsd - the structure's XML schema definition

serviceContext - the service context to be applied. Can set the UUID, creation date, modification date, guest permissions, and group permissions for the structure.

Returns:

the structure

Throws:

PortalException - if a user with the primary key could not be found, if the user did not have permission to add the structure, if the XSD was not well-formed, or if a portal exception occurred

SystemException - if a system exception occurred

addStructure

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

Adds a structure referencing its parent structure.

Parameters:

groupId - the primary key of the group

parentStructureId - the primary key of the parent structure (optionally DDMStructureConstants.DEFAULT_PARENT_STRUCTURE_ID)

classNameId - the primary key of the class name for the structure's related model

structureKey - the unique string identifying the structure (optionally null)

nameMap - the structure's locales and localized names

descriptionMap - the structure's locales and localized descriptions

xsd - the structure's XML schema definition

storageType - the structure's storage type. It can be "xml" or "expando". For more information, see StorageType.

type - the structure's type. For more information, see DDMStructureConstants.

serviceContext - the service context to be applied. Can set the UUID, creation date, modification date, guest permissions, and group permissions for the structure.

Returns:

the structure

Throws:

PortalException - if the user did not have permission to add the structure, if the XSD is not well formed, or if a portal exception occurred

SystemException - if a system exception occurred

addStructure

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

Adds a structure referencing the parent structure by its structure key. In case the parent structure is not found, it uses the default parent structure ID.

Parameters:

userId - the primary key of the structure's creator/owner

groupId - the primary key of the group

parentStructureKey - the unique string identifying the structure

classNameId - the primary key of the class name for the structure's related model

structureKey - unique string identifying the structure (optionally null)

nameMap - the structure's locales and localized names

descriptionMap - the structure's locales and localized descriptions

xsd - the XML schema definition of the structure

storageType - the storage type of the structure. It can be XML or expando. For more information, see StorageType.

type - the structure's type. For more information, see DDMStructureConstants.

serviceContext - the service context to be applied. Must have the ddmResource attribute to check permissions. Can set the UUID, creation date, modification date, guest permissions, and group permissions for the structure.

Returns:

the structure

Throws:

PortalException - if a user with the primary key could not be found, if the user did not have permission to add the structure, if the XSD was not well-formed, or if a portal exception occurred

SystemException - if a system exception occurred

copyStructure

DDMStructure copyStructure(long structureId,
                         java.util.Map<java.util.Locale,java.lang.String> nameMap,
                         java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                         ServiceContext serviceContext)
                           throws PortalException,
                                  SystemException

Copies a structure, creating a new structure with all the values extracted from the original one. The new structure supports a new name and description.

Parameters:

structureId - the primary key of the structure to be copied

nameMap - the new structure's locales and localized names

descriptionMap - the new structure's locales and localized descriptions

serviceContext - the service context to be applied. Can set the UUID, creation date, modification date, guest permissions, and group permissions for the structure.

Returns:

the new structure

Throws:

PortalException - if the user did not have permission to add the structure or if a portal exception occurred

SystemException - if a system exception occurred

copyStructure

DDMStructure copyStructure(long structureId,
                         ServiceContext serviceContext)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

deleteStructure

void deleteStructure(long structureId)
                     throws PortalException,
                            SystemException

Deletes the structure and its resources.

Before deleting the structure, the system verifies whether the structure is required by another entity. If it is needed, an exception is thrown.

Parameters:

structureId - the primary key of the structure to be deleted

Throws:

PortalException - if the user did not have permission to delete the structure or if a portal exception occurred

SystemException - if a system exception occurred

fetchStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructure fetchStructure(long groupId,
                                                                   long classNameId,
                                                                   java.lang.String structureKey)
                            throws PortalException,
                                   SystemException

Returns the structure matching the class name ID, structure key, and group.

Parameters:

groupId - the primary key of the group

classNameId - the primary key of the class name for the structure's related model

structureKey - the unique string identifying the structure

Returns:

the matching structure, or null if a matching structure could not be found

Throws:

PortalException - if the user did not have permission to view the structure or if a portal exception occurred

SystemException - if a system exception occurred

getStructure

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

Returns the structure with the ID.

Parameters:

structureId - the primary key of the structure

Returns:

the structure with the ID

Throws:

PortalException - if the user did not have permission to view the structure or if a structure with the ID could not be found

SystemException - if a system exception occurred

getStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructure getStructure(long groupId,
                                                                 long classNameId,
                                                                 java.lang.String structureKey)
                          throws PortalException,
                                 SystemException

Returns the structure matching the class name ID, structure key, and group.

Parameters:

groupId - the primary key of the structure's group

classNameId - the primary key of the class name for the structure's related model

structureKey - the unique string identifying the structure

Returns:

the matching structure

Throws:

PortalException - if the user did not have permission to view the structure or if a matching structure could not be found

SystemException - if a system exception occurred

getStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructure getStructure(long groupId,
                                                                 long classNameId,
                                                                 java.lang.String structureKey,
                                                                 boolean includeGlobalStructures)
                          throws PortalException,
                                 SystemException

Returns the structure matching the class name ID, structure key, and group, optionally in the global scope.

This method first searches in the group. If the structure is still not found and includeGlobalStructures is set to true, this method searches the global group.

Parameters:

groupId - the primary key of the structure's group

classNameId - the primary key of the class name for the structure's related model

structureKey - the unique string identifying the structure

includeGlobalStructures - whether to include the global scope in the search

Returns:

the matching structure

Throws:

PortalException - if the user did not have permission to view the structure or if a matching structure could not be found

SystemException - if a system exception occurred

getStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMStructure> getStructures(long groupId)
                                           throws SystemException

Returns all the structures in the group that the user has permission to view.

Parameters:

groupId - the primary key of the group

Returns:

the structures in the group that the user has permission to view

Throws:

SystemException - if a system exception occurred

getStructures

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

Returns all the structures in the groups that the user has permission to view.

Parameters:

groupIds - the primary key of the groups

Returns:

the structures in the groups that the user has permission to view

Throws:

SystemException - if a system exception occurred

getStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMStructure> getStructures(long[] groupIds,
                                                                                  long classNameId)
                                           throws SystemException

Throws:

SystemException

getStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMStructure> getStructures(long[] groupIds,
                                                                                  long classNameId,
                                                                                  int start,
                                                                                  int end)
                                           throws SystemException

Throws:

SystemException

search

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

Returns an ordered range of all the structures matching the groups and class name IDs, and matching the keywords in the structure names and descriptions.

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:

companyId - the primary key of the structure's company

groupIds - the primary keys of the groups

classNameIds - the primary keys of the class names of the models the structures are related to

keywords - the keywords (space separated), which may occur in the structure's name or description (optionally null)

start - the lower bound of the range of structures to return

end - the upper bound of the range of structures to return (not inclusive)

orderByComparator - the comparator to order the structures (optionally null)

Returns:

the range of matching structures ordered by the comparator

Throws:

SystemException - if a system exception occurred

search

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

Returns an ordered range of all the structures matching the groups, class name IDs, name keyword, description keyword, storage type, and type.

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:

companyId - the primary key of the structure's company

groupIds - the primary keys of the groups

classNameIds - the primary keys of the class names of the models the structures are related to

name - the name keywords

description - the description keywords

storageType - the structure's storage type. It can be "xml" or "expando". For more information, see StorageType.

type - the structure's type. For more information, see DDMStructureConstants.

andOperator - whether every field must match its keywords, or just one field

start - the lower bound of the range of structures to return

end - the upper bound of the range of structures to return (not inclusive)

orderByComparator - the comparator to order the structures (optionally null)

Returns:

the range of matching structures ordered by the comparator

Throws:

SystemException - if a system exception occurred

searchCount

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

Returns the number of structures matching the groups and class name IDs, and matching the keywords in the structure names and descriptions.

Parameters:

companyId - the primary key of the structure's company

groupIds - the primary keys of the groups

classNameIds - the primary keys of the class names of the models the structures are related to

keywords - the keywords (space separated), which may occur in the structure's name or description (optionally null)

Returns:

the number of matching structures

Throws:

SystemException - if a system exception occurred

searchCount

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

Returns the number of structures matching the groups, class name IDs, name keyword, description keyword, storage type, and type

Parameters:

companyId - the primary key of the structure's company

groupIds - the primary keys of the groups

classNameIds - the primary keys of the class names of the models the structure's are related to

name - the name keywords

description - the description keywords

storageType - the structure's storage type. It can be "xml" or "expando". For more information, see StorageType.

type - the structure's type. For more information, see DDMStructureConstants.

andOperator - whether every field must match its keywords, or just one field

Returns:

the number of matching structures

Throws:

SystemException - if a system exception occurred

updateStructure

DDMStructure updateStructure(long groupId,
                           long parentStructureId,
                           long classNameId,
                           java.lang.String structureKey,
                           java.util.Map<java.util.Locale,java.lang.String> nameMap,
                           java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                           java.lang.String xsd,
                           ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException

Updates the structure matching the class name ID, structure key, and group, replacing its old parent structure, name map, description map, and XSD with new ones.

Parameters:

groupId - the primary key of the group

parentStructureId - the primary key of the new parent structure

classNameId - the primary key of the class name for the structure's related model

structureKey - the unique string identifying the structure

nameMap - the structure's new locales and localized names

descriptionMap - the structure's new locales and localized description

xsd - the structure's new XML schema definition

serviceContext - the service context to be applied. Can set the modification date.

Returns:

the updated structure

Throws:

PortalException - if the user did not have permission to update the structure or if a portal exception occurred

SystemException - if a system exception occurred

updateStructure

DDMStructure updateStructure(long structureId,
                           long parentStructureId,
                           java.util.Map<java.util.Locale,java.lang.String> nameMap,
                           java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                           java.lang.String xsd,
                           ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException

Updates the structure matching the structure ID, replacing the old parent structure ID, name map, description map, and XSD with the new values.

Parameters:

structureId - the primary key of the structure

parentStructureId - the new parent structure primary key

nameMap - the structure's new locales and localized names

descriptionMap - the structure's new locales and localized description

xsd - the new XML schema definition of the structure

serviceContext - the service context to be applied. Can set the modification date.

Returns:

the updated structure

Throws:

PortalException - if the user did not have permission to update the structure or if a portal exception occurred

SystemException - if a system exception occurred