com.liferay.dynamic.data.mapping.service

Interface DDMStructureLocalService

All Superinterfaces:

com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

All Known Implementing Classes:

DDMStructureLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface DDMStructureLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

Provides the local service interface for DDMStructure. 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:

DDMStructureLocalServiceUtil, com.liferay.dynamic.data.mapping.service.base.DDMStructureLocalServiceBaseImpl, com.liferay.dynamic.data.mapping.service.impl.DDMStructureLocalServiceImpl

Generated:

Method Summary

Modifier and Type	Method and Description
DDMStructure	addDDMStructure(DDMStructure ddmStructure) Adds the ddm structure to the database.
DDMStructure	addStructure(long userId, 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, DDMForm ddmForm, DDMFormLayout ddmFormLayout, java.lang.String storageType, int type, com.liferay.portal.kernel.service.ServiceContext serviceContext)
DDMStructure	addStructure(long userId, 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 definition, java.lang.String storageType, int type, com.liferay.portal.kernel.service.ServiceContext serviceContext) Deprecated. As of 2.1.0, replaced by addStructure(long, long, long, long, String, Map, Map, DDMForm, DDMFormLayout, String, int, ServiceContext)
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, DDMForm ddmForm, DDMFormLayout ddmFormLayout, java.lang.String storageType, com.liferay.portal.kernel.service.ServiceContext serviceContext)
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 definition, com.liferay.portal.kernel.service.ServiceContext serviceContext) Deprecated. As of 2.1.0, replaced by #addStructure(long, long, long, Map, Map, DDMForm, DDMFormLayout, ServiceContext)
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, DDMForm ddmForm, DDMFormLayout ddmFormLayout, java.lang.String storageType, int type, com.liferay.portal.kernel.service.ServiceContext serviceContext)
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 definition, java.lang.String storageType, int type, com.liferay.portal.kernel.service.ServiceContext serviceContext) Deprecated. As of 2.1.0, replaced by addStructure(long, long, String, long, String, Map, Map, DDMForm, DDMFormLayout, String, int, ServiceContext)
void	addStructureResources(DDMStructure structure, boolean addGroupPermissions, boolean addGuestPermissions) Adds the resources to the structure.
void	addStructureResources(DDMStructure structure, com.liferay.portal.kernel.service.permission.ModelPermissions modelPermissions) Adds the model resources with the permissions to the structure.
DDMStructure	copyStructure(long userId, long structureId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) Copies a structure, creating a new structure with all the values extracted from the original one.
DDMStructure	copyStructure(long userId, long structureId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
DDMStructure	createDDMStructure(long structureId) Creates a new ddm structure with the primary key.
DDMStructure	deleteDDMStructure(DDMStructure ddmStructure) Deletes the ddm structure from the database.
DDMStructure	deleteDDMStructure(long structureId) Deletes the ddm structure with the primary key from the database.
com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
void	deleteStructure(DDMStructure structure) Deletes the structure and its resources.
void	deleteStructure(long structureId) Deletes the structure and its resources.
void	deleteStructure(long groupId, long classNameId, java.lang.String structureKey) Deletes the matching structure and its resources.
void	deleteStructures(long groupId) Deletes all the structures of the group.
void	deleteStructures(long groupId, long classNameId)
com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.
DDMStructure	fetchDDMStructure(long structureId)
DDMStructure	fetchDDMStructureByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the ddm structure matching the UUID and group.
DDMStructure	fetchStructure(long structureId) Returns the structure with the ID.
DDMStructure	fetchStructure(long groupId, long classNameId, java.lang.String structureKey) Returns the structure matching the class name ID, structure key, and group.
DDMStructure	fetchStructure(long groupId, long classNameId, java.lang.String structureKey, boolean includeAncestorStructures) Returns the structure matching the class name ID, structure key, and group, optionally searching ancestor sites (that have sharing enabled) and global scoped sites.
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
java.util.List<DDMStructure>	getChildrenStructures(long parentStructureId)
java.util.List<DDMStructure>	getClassStructures(long companyId, long classNameId) Returns all the structures matching the class name ID.
java.util.List<DDMStructure>	getClassStructures(long companyId, long classNameId, int start, int end) Returns a range of all the structures matching the class name ID.
java.util.List<DDMStructure>	getClassStructures(long companyId, long classNameId, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator) Returns all the structures matching the class name ID ordered by the comparator.
DDMStructure	getDDMStructure(long structureId) Returns the ddm structure with the primary key.
DDMStructure	getDDMStructureByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the ddm structure matching the UUID and group.
java.util.List<DDMStructure>	getDDMStructures(int start, int end) Returns a range of all the ddm structures.
java.util.List<DDMStructure>	getDDMStructuresByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns all the ddm structures matching the UUID and company.
java.util.List<DDMStructure>	getDDMStructuresByUuidAndCompanyId(java.lang.String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator) Returns a range of ddm structures matching the UUID and company.
int	getDDMStructuresCount() Returns the number of ddm structures.
com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery	getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
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 includeAncestorStructures) Returns the structure matching the class name ID, structure key, and group, optionally searching ancestor sites (that have sharing enabled) and global scoped sites.
java.util.List<DDMStructure>	getStructure(long groupId, java.lang.String name, java.lang.String description) Returns all the structures matching the group, name, and description.
DDMForm	getStructureDDMForm(DDMStructure structure)
java.util.List<DDMStructure>	getStructures() Returns all the structures present in the system.
java.util.List<DDMStructure>	getStructures(long groupId) Returns all the structures present in the group.
java.util.List<DDMStructure>	getStructures(long[] groupIds) Returns all the structures belonging to the groups.
java.util.List<DDMStructure>	getStructures(long[] groupIds, long classNameId) Returns all the structures matching the class name ID and belonging to the groups.
java.util.List<DDMStructure>	getStructures(long[] groupIds, long classNameId, int start, int end) Returns a range of all the structures matching the class name ID and belonging to the groups.
java.util.List<DDMStructure>	getStructures(long groupId, int start, int end) Returns a range of all the structures belonging to the group.
java.util.List<DDMStructure>	getStructures(long groupId, long classNameId) Returns all the structures matching class name ID and group.
java.util.List<DDMStructure>	getStructures(long groupId, long classNameId, int start, int end) Returns a range of all the structures that match the class name ID and group.
java.util.List<DDMStructure>	getStructures(long groupId, long classNameId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator) Returns an ordered range of all the structures matching the class name ID and group.
java.util.List<DDMStructure>	getStructures(long groupId, java.lang.String name, java.lang.String description)
int	getStructuresCount(long groupId) Returns the number of structures belonging to the group.
int	getStructuresCount(long[] groupIds, long classNameId) Returns the number of structures matching the class name ID and belonging to the groups.
int	getStructuresCount(long groupId, long classNameId) Returns the number of structures matching the class name ID and group.
java.lang.String	prepareLocalizedDefinitionForImport(DDMStructure structure, java.util.Locale defaultImportLocale)
void	revertStructure(long userId, long structureId, java.lang.String version, com.liferay.portal.kernel.service.ServiceContext serviceContext)
java.util.List<DDMStructure>	search(long companyId, long[] groupIds, long classNameId, java.lang.String keywords, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> 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 classNameId, java.lang.String name, java.lang.String description, java.lang.String storageType, int type, int status, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> 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 classNameId, java.lang.String keywords, int status) 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 classNameId, java.lang.String name, java.lang.String description, java.lang.String storageType, int type, int status, boolean andOperator) Returns the number of structures matching the groups, class name IDs, name keyword, description keyword, storage type, and type
DDMStructure	updateDDMStructure(DDMStructure ddmStructure) Updates the ddm structure in the database or adds it if it does not yet exist.
DDMStructure	updateStructure(long userId, long structureId, DDMForm ddmForm, DDMFormLayout ddmFormLayout, com.liferay.portal.kernel.service.ServiceContext serviceContext)
DDMStructure	updateStructure(long userId, 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, DDMForm ddmForm, DDMFormLayout ddmFormLayout, com.liferay.portal.kernel.service.ServiceContext serviceContext)
DDMStructure	updateStructure(long userId, long structureId, long parentStructureId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, DDMForm ddmForm, DDMFormLayout ddmFormLayout, com.liferay.portal.kernel.service.ServiceContext serviceContext)
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 definition, com.liferay.portal.kernel.service.ServiceContext serviceContext) Deprecated. As of 2.1.0, replaced by updateStructure(long, long, long, long, String, Map, Map, DDMForm, DDMFormLayout, ServiceContext)
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 definition, com.liferay.portal.kernel.service.ServiceContext serviceContext) Deprecated. As of 2.1.0, replaced by updateStructure(long, long, long, Map, Map, DDMForm, DDMFormLayout, ServiceContext)
DDMStructure	updateXSD(long structureId, java.lang.String definition, com.liferay.portal.kernel.service.ServiceContext serviceContext) Deprecated. As of 2.1.0, replaced by #updateStructure(long, DDMForm, DDMFormLayout, ServiceContext)

Method Detail

getStructureDDMForm

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMForm getStructureDDMForm(DDMStructure structure)
                                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addDDMStructure

@Indexable(type=REINDEX)
DDMStructure addDDMStructure(DDMStructure ddmStructure)

Adds the ddm structure to the database. Also notifies the appropriate model listeners.

Parameters:

ddmStructure - the ddm structure

Returns:

the ddm structure that was added

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,
                          DDMForm ddmForm,
                          DDMFormLayout ddmFormLayout,
                          java.lang.String storageType,
                          int type,
                          com.liferay.portal.kernel.service.ServiceContext serviceContext)
                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addStructure

@Deprecated
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 definition,
                                      java.lang.String storageType,
                                      int type,
                                      com.liferay.portal.kernel.service.ServiceContext serviceContext)
                               throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of 2.1.0, replaced by addStructure(long, long, String, long, String, Map, Map, DDMForm, DDMFormLayout, String, int, ServiceContext)

Adds a structure referencing a default parent structure if the parent structure is not found.

Parameters:

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

groupId - the primary key of the group

parentStructureKey - the unique string identifying the parent structure (optionally null)

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

definition - 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:

com.liferay.portal.kernel.exception.PortalException

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,
                          DDMForm ddmForm,
                          DDMFormLayout ddmFormLayout,
                          java.lang.String storageType,
                          com.liferay.portal.kernel.service.ServiceContext serviceContext)
                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addStructure

@Deprecated
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 definition,
                                      com.liferay.portal.kernel.service.ServiceContext serviceContext)
                               throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of 2.1.0, replaced by #addStructure(long, long, long, Map, Map, DDMForm, DDMFormLayout, ServiceContext)

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

definition - 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:

com.liferay.portal.kernel.exception.PortalException

addStructure

DDMStructure addStructure(long userId,
                          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,
                          DDMForm ddmForm,
                          DDMFormLayout ddmFormLayout,
                          java.lang.String storageType,
                          int type,
                          com.liferay.portal.kernel.service.ServiceContext serviceContext)
                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addStructure

@Deprecated
DDMStructure addStructure(long userId,
                                      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 definition,
                                      java.lang.String storageType,
                                      int type,
                                      com.liferay.portal.kernel.service.ServiceContext serviceContext)
                               throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of 2.1.0, replaced by addStructure(long, long, long, long, String, Map, Map, DDMForm, DDMFormLayout, String, int, ServiceContext)

Adds a structure referencing its parent structure.

Parameters:

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

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

definition - 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:

com.liferay.portal.kernel.exception.PortalException

copyStructure

DDMStructure copyStructure(long userId,
                           long structureId,
                           com.liferay.portal.kernel.service.ServiceContext serviceContext)
                    throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

copyStructure

DDMStructure copyStructure(long userId,
                           long structureId,
                           java.util.Map<java.util.Locale,java.lang.String> nameMap,
                           java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                           com.liferay.portal.kernel.service.ServiceContext serviceContext)
                    throws com.liferay.portal.kernel.exception.PortalException

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:

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

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:

com.liferay.portal.kernel.exception.PortalException

createDDMStructure

DDMStructure createDDMStructure(long structureId)

Creates a new ddm structure with the primary key. Does not add the ddm structure to the database.

Parameters:

structureId - the primary key for the new ddm structure

Returns:

the new ddm structure

deleteDDMStructure

@Indexable(type=DELETE)
DDMStructure deleteDDMStructure(DDMStructure ddmStructure)

Deletes the ddm structure from the database. Also notifies the appropriate model listeners.

Parameters:

ddmStructure - the ddm structure

Returns:

the ddm structure that was removed

deleteDDMStructure

@Indexable(type=DELETE)
DDMStructure deleteDDMStructure(long structureId)
                                                 throws com.liferay.portal.kernel.exception.PortalException

Deletes the ddm structure with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

structureId - the primary key of the ddm structure

Returns:

the ddm structure that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException - if a ddm structure with the primary key could not be found

fetchDDMStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructure fetchDDMStructure(long structureId)

fetchDDMStructureByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructure fetchDDMStructureByUuidAndGroupId(java.lang.String uuid,
                                                                                                                  long groupId)

Returns the ddm structure matching the UUID and group.

Parameters:

uuid - the ddm structure's UUID

groupId - the primary key of the group

Returns:

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

fetchStructure

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

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

fetchStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructure fetchStructure(long groupId,
                                                                                               long classNameId,
                                                                                               java.lang.String structureKey,
                                                                                               boolean includeAncestorStructures)
                                                                                        throws com.liferay.portal.kernel.exception.PortalException

Returns the structure matching the class name ID, structure key, and group, optionally searching ancestor sites (that have sharing enabled) and global scoped sites.

This method first searches in the group. If the structure is still not found and includeAncestorStructures is set to true, this method searches the group's ancestor sites (that have sharing enabled) and lastly searches global scoped sites.

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

includeAncestorStructures - whether to include ancestor sites (that have sharing enabled) and include global scoped sites in the search

Returns:

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

Throws:

com.liferay.portal.kernel.exception.PortalException

fetchStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructure fetchStructure(long structureId)

Returns the structure with the ID.

Parameters:

structureId - the primary key of the structure

Returns:

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

getDDMStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructure getDDMStructure(long structureId)
                                                                                         throws com.liferay.portal.kernel.exception.PortalException

Returns the ddm structure with the primary key.

Parameters:

structureId - the primary key of the ddm structure

Returns:

the ddm structure

Throws:

com.liferay.portal.kernel.exception.PortalException - if a ddm structure with the primary key could not be found

getDDMStructureByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructure getDDMStructureByUuidAndGroupId(java.lang.String uuid,
                                                                                                                long groupId)
                                                                                                         throws com.liferay.portal.kernel.exception.PortalException

Returns the ddm structure matching the UUID and group.

Parameters:

uuid - the ddm structure's UUID

groupId - the primary key of the group

Returns:

the matching ddm structure

Throws:

com.liferay.portal.kernel.exception.PortalException - if a matching ddm structure could not be found

getStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructure getStructure(long groupId,
                                                                                             long classNameId,
                                                                                             java.lang.String structureKey)
                                                                                      throws com.liferay.portal.kernel.exception.PortalException

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:

com.liferay.portal.kernel.exception.PortalException

getStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructure getStructure(long groupId,
                                                                                             long classNameId,
                                                                                             java.lang.String structureKey,
                                                                                             boolean includeAncestorStructures)
                                                                                      throws com.liferay.portal.kernel.exception.PortalException

Returns the structure matching the class name ID, structure key, and group, optionally searching ancestor sites (that have sharing enabled) and global scoped sites.

This method first searches in the group. If the structure is still not found and includeAncestorStructures is set to true, this method searches the group's ancestor sites (that have sharing enabled) and lastly searches global scoped sites.

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

includeAncestorStructures - whether to include ancestor sites (that have sharing enabled) and include global scoped sites in the search in the search

Returns:

the matching structure

Throws:

com.liferay.portal.kernel.exception.PortalException

getStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructure getStructure(long structureId)
                                                                                      throws com.liferay.portal.kernel.exception.PortalException

Returns the structure with the ID.

Parameters:

structureId - the primary key of the structure

Returns:

the structure with the ID

Throws:

com.liferay.portal.kernel.exception.PortalException

updateDDMStructure

@Indexable(type=REINDEX)
DDMStructure updateDDMStructure(DDMStructure ddmStructure)

Updates the ddm structure in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

ddmStructure - the ddm structure

Returns:

the ddm structure that was updated

updateStructure

@Deprecated
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 definition,
                                         com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                  throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of 2.1.0, replaced by updateStructure(long, long, long, long, String, Map, Map, DDMForm, DDMFormLayout, 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.

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

definition - the structure's new XML schema definition

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

Returns:

the updated structure

Throws:

com.liferay.portal.kernel.exception.PortalException

updateStructure

@Deprecated
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 definition,
                                         com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                  throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of 2.1.0, replaced by updateStructure(long, long, long, Map, Map, DDMForm, DDMFormLayout, ServiceContext)

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

Parameters:

structureId - the primary key of the structure

parentStructureId - the primary key of the new parent structure

nameMap - the structure's new locales and localized names

descriptionMap - the structure's new locales and localized descriptions

definition - the structure's new XML schema definition

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

Returns:

the updated structure

Throws:

com.liferay.portal.kernel.exception.PortalException

updateStructure

DDMStructure updateStructure(long userId,
                             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,
                             DDMForm ddmForm,
                             DDMFormLayout ddmFormLayout,
                             com.liferay.portal.kernel.service.ServiceContext serviceContext)
                      throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateStructure

DDMStructure updateStructure(long userId,
                             long structureId,
                             DDMForm ddmForm,
                             DDMFormLayout ddmFormLayout,
                             com.liferay.portal.kernel.service.ServiceContext serviceContext)
                      throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateStructure

DDMStructure updateStructure(long userId,
                             long structureId,
                             long parentStructureId,
                             java.util.Map<java.util.Locale,java.lang.String> nameMap,
                             java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                             DDMForm ddmForm,
                             DDMFormLayout ddmFormLayout,
                             com.liferay.portal.kernel.service.ServiceContext serviceContext)
                      throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateXSD

@Deprecated
DDMStructure updateXSD(long structureId,
                                   java.lang.String definition,
                                   com.liferay.portal.kernel.service.ServiceContext serviceContext)
                            throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of 2.1.0, replaced by #updateStructure(long, DDMForm, DDMFormLayout, ServiceContext)

Updates the structure matching the structure ID, replacing its XSD with a new one.

Parameters:

structureId - the primary key of the structure

definition - the structure's new XML schema definition

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

Returns:

the updated structure

Throws:

com.liferay.portal.kernel.exception.PortalException

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

dynamicQuery

com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

deletePersistedModel

com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

getDDMStructuresCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getDDMStructuresCount()

Returns the number of ddm structures.

Returns:

the number of ddm structures

getStructuresCount

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

Returns the number of structures belonging to the group.

Parameters:

groupId - the primary key of the group

Returns:

the number of structures belonging to the group

getStructuresCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getStructuresCount(long groupId,
                                                                                          long classNameId)

Returns the number of structures matching the class name ID and group.

Parameters:

groupId - the primary key of the group

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

Returns:

the number of matching structures

getStructuresCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getStructuresCount(long[] groupIds,
                                                                                          long classNameId)

Returns the number of structures matching the class name ID and belonging to the groups.

Parameters:

groupIds - the primary keys of the groups

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

Returns:

the number of matching structures

searchCount

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

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

classNameId - the primary key of the class name of the model the structure is 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

searchCount

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

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

classNameId -

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

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

prepareLocalizedDefinitionForImport

java.lang.String prepareLocalizedDefinitionForImport(DDMStructure structure,
                                                     java.util.Locale defaultImportLocale)

dynamicQuery

<T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)

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

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

<T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                   int start,
                                   int end)

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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from DDMStructureModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

dynamicQuery

<T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                   int start,
                                   int end,
                                   com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)

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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from DDMStructureModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

getChildrenStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMStructure> getChildrenStructures(long parentStructureId)

getClassStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMStructure> getClassStructures(long companyId,
                                                                                                                   long classNameId)

Returns all the structures matching the class name ID.

Parameters:

companyId - the primary key of the structure's company

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

Returns:

the structures matching the class name ID

getClassStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMStructure> getClassStructures(long companyId,
                                                                                                                   long classNameId,
                                                                                                                   com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator)

Returns all the structures matching the class name ID ordered by the comparator.

Parameters:

companyId - the primary key of the structure's company

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

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

Returns:

the matching structures ordered by the comparator

getClassStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMStructure> getClassStructures(long companyId,
                                                                                                                   long classNameId,
                                                                                                                   int start,
                                                                                                                   int end)

Returns a range of all the structures matching the class name ID.

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

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

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

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

Returns:

the range of matching structures

getDDMStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMStructure> getDDMStructures(int start,
                                                                                                                 int end)

Returns a range of all the ddm structures.

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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from DDMStructureModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

start - the lower bound of the range of ddm structures

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

Returns:

the range of ddm structures

getDDMStructuresByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMStructure> getDDMStructuresByUuidAndCompanyId(java.lang.String uuid,
                                                                                                                                   long companyId)

Returns all the ddm structures matching the UUID and company.

Parameters:

uuid - the UUID of the ddm structures

companyId - the primary key of the company

Returns:

the matching ddm structures, or an empty list if no matches were found

getDDMStructuresByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMStructure> getDDMStructuresByUuidAndCompanyId(java.lang.String uuid,
                                                                                                                                   long companyId,
                                                                                                                                   int start,
                                                                                                                                   int end,
                                                                                                                                   com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator)

Returns a range of ddm structures matching the UUID and company.

Parameters:

uuid - the UUID of the ddm structures

companyId - the primary key of the company

start - the lower bound of the range of ddm structures

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

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

Returns:

the range of matching ddm structures, or an empty list if no matches were found

getStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMStructure> getStructure(long groupId,
                                                                                                             java.lang.String name,
                                                                                                             java.lang.String description)

Returns all the structures matching the group, name, and description.

Parameters:

groupId - the primary key of the structure's group

name - the structure's name

description - the structure's description

Returns:

the matching structures

getStructures

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

Returns all the structures present in the system.

Returns:

the structures present in the system

getStructures

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

Returns all the structures present in the group.

Parameters:

groupId - the primary key of the group

Returns:

the structures present in the group

getStructures

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

Returns a range of all the structures belonging to the group.

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:

groupId - the primary key of the group

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

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

Returns:

the range of matching structures

getStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMStructure> getStructures(long groupId,
                                                                                                              java.lang.String name,
                                                                                                              java.lang.String description)

getStructures

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

Returns all the structures matching class name ID and group.

Parameters:

groupId - the primary key of the group

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

Returns:

the matching structures

getStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMStructure> getStructures(long groupId,
                                                                                                              long classNameId,
                                                                                                              int start,
                                                                                                              int end)

Returns a range of all the structures that match the class name ID and group.

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:

groupId - the primary key of the group

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

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

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

Returns:

the range of matching structures

getStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMStructure> getStructures(long groupId,
                                                                                                              long classNameId,
                                                                                                              int start,
                                                                                                              int end,
                                                                                                              com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator)

Returns an ordered range of all the structures matching the class name ID and group.

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:

groupId - the primary key of the group

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

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

getStructures

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

Returns all the structures belonging to the groups.

Parameters:

groupIds - the primary keys of the groups

Returns:

the structures belonging to the groups

getStructures

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

Returns all the structures matching the class name ID and belonging to the groups.

Parameters:

groupIds - the primary keys of the groups

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

Returns:

the matching structures

getStructures

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

Returns a range of all the structures matching the class name ID and belonging to the groups.

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:

groupIds - the primary keys of the groups

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

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

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

Returns:

the range of matching structures

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMStructure> search(long companyId,
                                                                                                       long[] groupIds,
                                                                                                       long classNameId,
                                                                                                       java.lang.String keywords,
                                                                                                       int status,
                                                                                                       int start,
                                                                                                       int end,
                                                                                                       com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> 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.

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

classNameId - the primary key of the class name of the model the structure is 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

search

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

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

classNameId - the primary key of the class name of the model the structure is 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

dynamicQueryCount

long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                       com.liferay.portal.kernel.dao.orm.Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

addStructureResources

void addStructureResources(DDMStructure structure,
                           boolean addGroupPermissions,
                           boolean addGuestPermissions)
                    throws com.liferay.portal.kernel.exception.PortalException

Adds the resources to the structure.

Parameters:

structure - the structure to add resources to

addGroupPermissions - whether to add group permissions

addGuestPermissions - whether to add guest permissions

Throws:

com.liferay.portal.kernel.exception.PortalException

addStructureResources

void addStructureResources(DDMStructure structure,
                           com.liferay.portal.kernel.service.permission.ModelPermissions modelPermissions)
                    throws com.liferay.portal.kernel.exception.PortalException

Adds the model resources with the permissions to the structure.

Parameters:

structure - the structure to add resources to

modelPermissions - the model permissions to be added

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteStructure

@SystemEvent(type=1)
void deleteStructure(DDMStructure structure)
                                   throws com.liferay.portal.kernel.exception.PortalException

Deletes the structure and its resources.

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

Parameters:

structure - the structure to be deleted

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteStructure

void deleteStructure(long groupId,
                     long classNameId,
                     java.lang.String structureKey)
              throws com.liferay.portal.kernel.exception.PortalException

Deletes the matching 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:

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

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteStructure

void deleteStructure(long structureId)
              throws com.liferay.portal.kernel.exception.PortalException

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:

com.liferay.portal.kernel.exception.PortalException

deleteStructures

void deleteStructures(long groupId)
               throws com.liferay.portal.kernel.exception.PortalException

Deletes all the structures of the group.

Before deleting the structures, the system verifies whether each structure is required by another entity. If any of the structures are needed, an exception is thrown.

Parameters:

groupId - the primary key of the group

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteStructures

void deleteStructures(long groupId,
                      long classNameId)
               throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

revertStructure

void revertStructure(long userId,
                     long structureId,
                     java.lang.String version,
                     com.liferay.portal.kernel.service.ServiceContext serviceContext)
              throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException