com.liferay.portlet.dynamicdatamapping.service
Interface DDMStructureLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

DDMStructureLocalServiceWrapper

@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface DDMStructureLocalService
extends BaseLocalService, 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.portlet.dynamicdatamapping.service.base.DDMStructureLocalServiceBaseImpl, com.liferay.portlet.dynamicdatamapping.service.impl.DDMStructureLocalServiceImpl

Method Summary

DDMStructure	addDDMStructure(DDMStructure ddmStructure) Adds the d d m structure to the database.
void	addDLFileEntryTypeDDMStructure(long fileEntryTypeId, DDMStructure ddmStructure)
void	addDLFileEntryTypeDDMStructure(long fileEntryTypeId, long structureId)
void	addDLFileEntryTypeDDMStructures(long fileEntryTypeId, List<DDMStructure> DDMStructures)
void	addDLFileEntryTypeDDMStructures(long fileEntryTypeId, long[] structureIds)
DDMStructure	addStructure(long userId, long groupId, long parentStructureId, long classNameId, String structureKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsd, String storageType, int type, ServiceContext serviceContext) Adds a structure referencing its parent structure.
DDMStructure	addStructure(long userId, long groupId, long classNameId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, 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 userId, long groupId, String parentStructureKey, long classNameId, String structureKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsd, String storageType, int type, ServiceContext serviceContext) Adds a structure referencing a default parent structure if the parent structure is not found.
void	addStructureResources(DDMStructure structure, boolean addGroupPermissions, boolean addGuestPermissions) Adds the resources to the structure.
void	addStructureResources(DDMStructure structure, String[] groupPermissions, String[] guestPermissions) Adds the model resources with the permissions to the structure.
void	clearDLFileEntryTypeDDMStructures(long fileEntryTypeId)
DDMStructure	copyStructure(long userId, long structureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, ServiceContext serviceContext) Copies a structure, creating a new structure with all the values extracted from the original one.
DDMStructure	copyStructure(long userId, long structureId, ServiceContext serviceContext)
DDMStructure	createDDMStructure(long structureId) Creates a new d d m structure with the primary key.
DDMStructure	deleteDDMStructure(DDMStructure ddmStructure) Deletes the d d m structure from the database.
DDMStructure	deleteDDMStructure(long structureId) Deletes the d d m structure with the primary key from the database.
void	deleteDLFileEntryTypeDDMStructure(long fileEntryTypeId, DDMStructure ddmStructure)
void	deleteDLFileEntryTypeDDMStructure(long fileEntryTypeId, long structureId)
void	deleteDLFileEntryTypeDDMStructures(long fileEntryTypeId, List<DDMStructure> DDMStructures)
void	deleteDLFileEntryTypeDDMStructures(long fileEntryTypeId, long[] structureIds)
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, 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)
DynamicQuery	dynamicQuery()
List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
DDMStructure	fetchDDMStructure(long structureId)
DDMStructure	fetchDDMStructureByUuidAndCompanyId(String uuid, long companyId) Returns the d d m structure with the matching UUID and company.
DDMStructure	fetchDDMStructureByUuidAndGroupId(String uuid, long groupId) Returns the d d m structure matching the UUID and group.
DDMStructure	fetchStructure(long structureId) Returns the structure with the ID.
DDMStructure	fetchStructure(long groupId, long classNameId, String structureKey) Returns the structure matching the class name ID, structure key, and group.
DDMStructure	fetchStructure(long groupId, long classNameId, String structureKey, boolean includeGlobalStructures) Returns the structure matching the class name ID, structure key, and group, optionally in the global scope.
String	getBeanIdentifier() Returns the Spring bean ID for this bean.
List<DDMStructure>	getClassStructures(long classNameId) Deprecated. As of 6.2.0, replaced by getClassStructures(long, long)
List<DDMStructure>	getClassStructures(long classNameId, int start, int end) Deprecated. As of 6.2.0, replaced by getClassStructures(long, long, int, int)
List<DDMStructure>	getClassStructures(long companyId, long classNameId) Returns all the structures matching the class name ID.
List<DDMStructure>	getClassStructures(long companyId, long classNameId, int start, int end) Returns a range of all the structures matching the class name ID.
List<DDMStructure>	getClassStructures(long companyId, long classNameId, OrderByComparator orderByComparator) Returns all the structures matching the class name ID ordered by the comparator.
List<DDMStructure>	getClassStructures(long classNameId, OrderByComparator orderByComparator) Deprecated. As of 6.2.0, replaced by getClassStructures(long, long, OrderByComparator)
DDMStructure	getDDMStructure(long structureId) Returns the d d m structure with the primary key.
DDMStructure	getDDMStructureByUuidAndCompanyId(String uuid, long companyId) Returns the d d m structure with the matching UUID and company.
DDMStructure	getDDMStructureByUuidAndGroupId(String uuid, long groupId) Returns the d d m structure matching the UUID and group.
List<DDMStructure>	getDDMStructures(int start, int end) Returns a range of all the d d m structures.
int	getDDMStructuresCount() Returns the number of d d m structures.
List<DDMStructure>	getDLFileEntryTypeDDMStructures(long fileEntryTypeId)
List<DDMStructure>	getDLFileEntryTypeDDMStructures(long fileEntryTypeId, int start, int end)
List<DDMStructure>	getDLFileEntryTypeDDMStructures(long fileEntryTypeId, int start, int end, OrderByComparator orderByComparator)
int	getDLFileEntryTypeDDMStructuresCount(long fileEntryTypeId)
List<DDMStructure>	getDLFileEntryTypeStructures(long dlFileEntryTypeId) Returns all the structures for the document library file entry type.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
DDMStructure	getStructure(long structureId) Returns the structure with the ID.
DDMStructure	getStructure(long groupId, long classNameId, String structureKey) Returns the structure matching the class name ID, structure key, and group.
DDMStructure	getStructure(long groupId, long classNameId, String structureKey, boolean includeGlobalStructures) Returns the structure matching the class name ID, structure key, and group, optionally in the global scope.
List<DDMStructure>	getStructure(long groupId, String name, String description) Returns all the structures matching the group, name, and description.
List<DDMStructure>	getStructureEntries() Deprecated. As of 6.2.0, replaced by getStructures()
List<DDMStructure>	getStructureEntries(long groupId) Deprecated. As of 6.2.0, replaced by getStructures(long)
List<DDMStructure>	getStructureEntries(long groupId, int start, int end) Deprecated. As of 6.2.0, replaced by getStructures(long, int, int)
List<DDMStructure>	getStructures() Returns all the structures present in the system.
List<DDMStructure>	getStructures(long groupId) Returns all the structures present in the group.
List<DDMStructure>	getStructures(long[] groupIds) Returns all the structures belonging to the groups.
List<DDMStructure>	getStructures(long[] groupIds, long classNameId) Returns all the structures matching the class name ID and belonging to the groups.
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.
List<DDMStructure>	getStructures(long groupId, int start, int end) Returns a range of all the structures belonging to the group.
List<DDMStructure>	getStructures(long groupId, long classNameId) Returns all the structures matching class name ID and group.
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.
List<DDMStructure>	getStructures(long groupId, long classNameId, int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the structures matching the class name ID and group.
List<DDMStructure>	getStructures(long groupId, String name, 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.
boolean	hasDLFileEntryTypeDDMStructure(long fileEntryTypeId, long structureId)
boolean	hasDLFileEntryTypeDDMStructures(long fileEntryTypeId)
List<DDMStructure>	search(long companyId, long[] groupIds, long[] classNameIds, 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.
List<DDMStructure>	search(long companyId, long[] groupIds, long[] classNameIds, String name, String description, String storageType, int type, boolean andOperator, int start, int end, OrderByComparator orderByComparator) 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, 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, String name, String description, 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(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setDLFileEntryTypeDDMStructures(long fileEntryTypeId, long[] structureIds)
DDMStructure	updateDDMStructure(DDMStructure ddmStructure) Updates the d d m structure in the database or adds it if it does not yet exist.
DDMStructure	updateStructure(long groupId, long parentStructureId, long classNameId, String structureKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, 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, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsd, ServiceContext serviceContext) Updates the structure matching the structure ID, replacing its old parent structure, name map, description map, and XSD with new ones.
DDMStructure	updateXSD(long structureId, String xsd, ServiceContext serviceContext) Updates the structure matching the structure ID, replacing its XSD with a new one.
void	updateXSDFieldMetadata(long structureId, String fieldName, String metadataEntryName, String metadataEntryValue, ServiceContext serviceContext) Deprecated. As of 6.2.0, with no direct replacement

Method Detail

addDDMStructure

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

Adds the d d m structure to the database. Also notifies the appropriate model listeners.

Parameters:

ddmStructure - the d d m structure

Returns:

the d d m structure that was added

Throws:

SystemException - if a system exception occurred

createDDMStructure

DDMStructure createDDMStructure(long structureId)

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

Parameters:

structureId - the primary key for the new d d m structure

Returns:

the new d d m structure

deleteDDMStructure

@Indexable(type=DELETE)
DDMStructure deleteDDMStructure(long structureId)
                                throws PortalException,
                                       SystemException

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

Parameters:

structureId - the primary key of the d d m structure

Returns:

the d d m structure that was removed

Throws:

PortalException - if a d d m structure with the primary key could not be found

SystemException - if a system exception occurred

deleteDDMStructure

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

Deletes the d d m structure from the database. Also notifies the appropriate model listeners.

Parameters:

ddmStructure - the d d m structure

Returns:

the d d m structure that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException

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

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException

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

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchDDMStructure

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

Throws:

SystemException

fetchDDMStructureByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructure fetchDDMStructureByUuidAndCompanyId(String uuid,
                                                                                          long companyId)
                                                 throws SystemException

Returns the d d m structure with the matching UUID and company.

Parameters:

uuid - the d d m structure's UUID

companyId - the primary key of the company

Returns:

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

Throws:

SystemException - if a system exception occurred

fetchDDMStructureByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructure fetchDDMStructureByUuidAndGroupId(String uuid,
                                                                                        long groupId)
                                               throws SystemException

Returns the d d m structure matching the UUID and group.

Parameters:

uuid - the d d m structure's UUID

groupId - the primary key of the group

Returns:

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

Throws:

SystemException - if a system exception occurred

getDDMStructure

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

Returns the d d m structure with the primary key.

Parameters:

structureId - the primary key of the d d m structure

Returns:

the d d m structure

Throws:

PortalException - if a d d m structure with the primary key could not be found

SystemException - if a system exception occurred

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

SystemException

getDDMStructureByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructure getDDMStructureByUuidAndCompanyId(String uuid,
                                                                                        long companyId)
                                               throws PortalException,
                                                      SystemException

Returns the d d m structure with the matching UUID and company.

Parameters:

uuid - the d d m structure's UUID

companyId - the primary key of the company

Returns:

the matching d d m structure

Throws:

PortalException - if a matching d d m structure could not be found

SystemException - if a system exception occurred

getDDMStructureByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructure getDDMStructureByUuidAndGroupId(String uuid,
                                                                                      long groupId)
                                             throws PortalException,
                                                    SystemException

Returns the d d m structure matching the UUID and group.

Parameters:

uuid - the d d m structure's UUID

groupId - the primary key of the group

Returns:

the matching d d m structure

Throws:

PortalException - if a matching d d m structure could not be found

SystemException - if a system exception occurred

getDDMStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getDDMStructures(int start,
                                                                             int end)
                                    throws SystemException

Returns a range of all the d d m 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 d d m structures

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

Returns:

the range of d d m structures

Throws:

SystemException - if a system exception occurred

getDDMStructuresCount

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

Returns the number of d d m structures.

Returns:

the number of d d m structures

Throws:

SystemException - if a system exception occurred

updateDDMStructure

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

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

Parameters:

ddmStructure - the d d m structure

Returns:

the d d m structure that was updated

Throws:

SystemException - if a system exception occurred

addDLFileEntryTypeDDMStructure

void addDLFileEntryTypeDDMStructure(long fileEntryTypeId,
                                    long structureId)
                                    throws SystemException

Throws:

SystemException - if a system exception occurred

addDLFileEntryTypeDDMStructure

void addDLFileEntryTypeDDMStructure(long fileEntryTypeId,
                                    DDMStructure ddmStructure)
                                    throws SystemException

Throws:

SystemException - if a system exception occurred

addDLFileEntryTypeDDMStructures

void addDLFileEntryTypeDDMStructures(long fileEntryTypeId,
                                     long[] structureIds)
                                     throws SystemException

Throws:

SystemException - if a system exception occurred

addDLFileEntryTypeDDMStructures

void addDLFileEntryTypeDDMStructures(long fileEntryTypeId,
                                     List<DDMStructure> DDMStructures)
                                     throws SystemException

Throws:

SystemException - if a system exception occurred

clearDLFileEntryTypeDDMStructures

void clearDLFileEntryTypeDDMStructures(long fileEntryTypeId)
                                       throws SystemException

Throws:

SystemException - if a system exception occurred

deleteDLFileEntryTypeDDMStructure

void deleteDLFileEntryTypeDDMStructure(long fileEntryTypeId,
                                       long structureId)
                                       throws SystemException

Throws:

SystemException - if a system exception occurred

deleteDLFileEntryTypeDDMStructure

void deleteDLFileEntryTypeDDMStructure(long fileEntryTypeId,
                                       DDMStructure ddmStructure)
                                       throws SystemException

Throws:

SystemException - if a system exception occurred

deleteDLFileEntryTypeDDMStructures

void deleteDLFileEntryTypeDDMStructures(long fileEntryTypeId,
                                        long[] structureIds)
                                        throws SystemException

Throws:

SystemException - if a system exception occurred

deleteDLFileEntryTypeDDMStructures

void deleteDLFileEntryTypeDDMStructures(long fileEntryTypeId,
                                        List<DDMStructure> DDMStructures)
                                        throws SystemException

Throws:

SystemException - if a system exception occurred

getDLFileEntryTypeDDMStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getDLFileEntryTypeDDMStructures(long fileEntryTypeId)
                                                   throws SystemException

Throws:

SystemException - if a system exception occurred

getDLFileEntryTypeDDMStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getDLFileEntryTypeDDMStructures(long fileEntryTypeId,
                                                                                            int start,
                                                                                            int end)
                                                   throws SystemException

Throws:

SystemException - if a system exception occurred

getDLFileEntryTypeDDMStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getDLFileEntryTypeDDMStructures(long fileEntryTypeId,
                                                                                            int start,
                                                                                            int end,
                                                                                            OrderByComparator orderByComparator)
                                                   throws SystemException

Throws:

SystemException - if a system exception occurred

getDLFileEntryTypeDDMStructuresCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getDLFileEntryTypeDDMStructuresCount(long fileEntryTypeId)
                                         throws SystemException

Throws:

SystemException - if a system exception occurred

hasDLFileEntryTypeDDMStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasDLFileEntryTypeDDMStructure(long fileEntryTypeId,
                                                                                long structureId)
                                       throws SystemException

Throws:

SystemException - if a system exception occurred

hasDLFileEntryTypeDDMStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasDLFileEntryTypeDDMStructures(long fileEntryTypeId)
                                        throws SystemException

Throws:

SystemException - if a system exception occurred

setDLFileEntryTypeDDMStructures

void setDLFileEntryTypeDDMStructures(long fileEntryTypeId,
                                     long[] structureIds)
                                     throws SystemException

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addStructure

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

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

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 a user with the primary key could not be found, if the XSD was not well-formed, or if a portal exception occurred

SystemException - if a system exception occurred

addStructure

DDMStructure addStructure(long userId,
                          long groupId,
                          long classNameId,
                          Map<Locale,String> nameMap,
                          Map<Locale,String> descriptionMap,
                          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 XSD was not well-formed, or if a portal exception occurred

SystemException - if a system exception occurred

addStructure

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

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

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 a user with the primary key could not be found, if the XSD was not well-formed, or if a portal exception occurred

SystemException - if a system exception occurred

addStructureResources

void addStructureResources(DDMStructure structure,
                           boolean addGroupPermissions,
                           boolean addGuestPermissions)
                           throws PortalException,
                                  SystemException

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:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

addStructureResources

void addStructureResources(DDMStructure structure,
                           String[] groupPermissions,
                           String[] guestPermissions)
                           throws PortalException,
                                  SystemException

Adds the model resources with the permissions to the structure.

Parameters:

structure - the structure to add resources to

groupPermissions - the group permissions to be added

guestPermissions - the guest permissions to be added

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

copyStructure

DDMStructure copyStructure(long userId,
                           long structureId,
                           Map<Locale,String> nameMap,
                           Map<Locale,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:

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:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

copyStructure

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

Throws:

PortalException

SystemException

deleteStructure

@SystemEvent(type=1)
void deleteStructure(DDMStructure structure)
                     throws PortalException,
                            SystemException

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:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

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 a portal exception occurred

SystemException - if a system exception occurred

deleteStructure

void deleteStructure(long groupId,
                     long classNameId,
                     String structureKey)
                     throws PortalException,
                            SystemException

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:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

deleteStructures

void deleteStructures(long groupId)
                      throws PortalException,
                             SystemException

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:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

deleteStructures

void deleteStructures(long groupId,
                      long classNameId)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

fetchStructure

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

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

Throws:

SystemException - if a system exception occurred

fetchStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructure fetchStructure(long groupId,
                                                                     long classNameId,
                                                                     String structureKey)
                            throws 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:

SystemException - if a system exception occurred

fetchStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructure fetchStructure(long groupId,
                                                                     long classNameId,
                                                                     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 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, or null if a matching structure could not be found

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

getClassStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getClassStructures(long classNameId)
                                      throws SystemException

Deprecated. As of 6.2.0, replaced by getClassStructures(long, long)

Throws:

SystemException

getClassStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getClassStructures(long classNameId,
                                                                               int start,
                                                                               int end)
                                      throws SystemException

Deprecated. As of 6.2.0, replaced by getClassStructures(long, long, int, int)

Throws:

SystemException

getClassStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getClassStructures(long companyId,
                                                                               long classNameId)
                                      throws SystemException

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

Throws:

SystemException - if a system exception occurred

getClassStructures

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

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

Throws:

SystemException - if a system exception occurred

getClassStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getClassStructures(long companyId,
                                                                               long classNameId,
                                                                               OrderByComparator orderByComparator)
                                      throws SystemException

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

Throws:

SystemException - if a system exception occurred

getClassStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getClassStructures(long classNameId,
                                                                               OrderByComparator orderByComparator)
                                      throws SystemException

Deprecated. As of 6.2.0, replaced by getClassStructures(long, long, OrderByComparator)

Throws:

SystemException

getDLFileEntryTypeStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getDLFileEntryTypeStructures(long dlFileEntryTypeId)
                                                throws SystemException

Returns all the structures for the document library file entry type.

Parameters:

dlFileEntryTypeId - the primary key of the document library file entry type

Returns:

the structures for the document library file entry type

Throws:

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 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,
                                                                   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 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,
                                                                   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 a matching structure could not be found

SystemException - if a system exception occurred

getStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getStructure(long groupId,
                                                                         String name,
                                                                         String description)
                                throws SystemException

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

Throws:

SystemException - if a system exception occurred

getStructureEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getStructureEntries()
                                       throws SystemException

Deprecated. As of 6.2.0, replaced by getStructures()

Throws:

SystemException

getStructureEntries

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

Deprecated. As of 6.2.0, replaced by getStructures(long)

Throws:

SystemException

getStructureEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getStructureEntries(long groupId,
                                                                                int start,
                                                                                int end)
                                       throws SystemException

Deprecated. As of 6.2.0, replaced by getStructures(long, int, int)

Throws:

SystemException

getStructures

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

Returns all the structures present in the system.

Returns:

the structures present in the system

Throws:

SystemException - if a system exception occurred

getStructures

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

Returns all the structures present in the group.

Parameters:

groupId - the primary key of the group

Returns:

the structures present in the group

Throws:

SystemException - if a system exception occurred

getStructures

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

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

Throws:

SystemException - if a system exception occurred

getStructures

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

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

Throws:

SystemException - if a system exception occurred

getStructures

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

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

Throws:

SystemException - if a system exception occurred

getStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getStructures(long groupId,
                                                                          long classNameId,
                                                                          int start,
                                                                          int end,
                                                                          OrderByComparator orderByComparator)
                                 throws SystemException

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

Throws:

SystemException - if a system exception occurred

getStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getStructures(long groupId,
                                                                          String name,
                                                                          String description)
                                 throws SystemException

Throws:

SystemException

getStructures

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

Returns all the structures belonging to the groups.

Parameters:

groupIds - the primary keys of the groups

Returns:

the structures belonging to the groups

Throws:

SystemException - if a system exception occurred

getStructures

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

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

Throws:

SystemException - if a system exception occurred

getStructures

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

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

Throws:

SystemException - if a system exception occurred

getStructuresCount

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

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

Throws:

SystemException - if a system exception occurred

getStructuresCount

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

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

Throws:

SystemException - if a system exception occurred

getStructuresCount

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

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

Throws:

SystemException - if a system exception occurred

search

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

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)
List<DDMStructure> search(long companyId,
                                                                   long[] groupIds,
                                                                   long[] classNameIds,
                                                                   String name,
                                                                   String description,
                                                                   String storageType,
                                                                   int type,
                                                                   boolean andOperator,
                                                                   int start,
                                                                   int end,
                                                                   OrderByComparator orderByComparator)
                          throws SystemException

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,
                                                         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,
                                                         String name,
                                                         String description,
                                                         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,
                             String structureKey,
                             Map<Locale,String> nameMap,
                             Map<Locale,String> descriptionMap,
                             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 structure's modification date.

Returns:

the updated structure

Throws:

PortalException - if a matching structure could not be found, if the XSD was not well-formed, or if a portal exception occurred

SystemException - if a system exception occurred

updateStructure

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

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

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

PortalException - if a matching structure could not be found, if the XSD was not well-formed, or if a portal exception occurred

SystemException - if a system exception occurred

updateXSD

DDMStructure updateXSD(long structureId,
                       String xsd,
                       ServiceContext serviceContext)
                       throws PortalException,
                              SystemException

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

Parameters:

structureId - the primary key of the structure

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

PortalException - if a matching structure could not be found, if the XSD was not well-formed, or if a portal exception occurred

SystemException - if a system exception occurred

updateXSDFieldMetadata

void updateXSDFieldMetadata(long structureId,
                            String fieldName,
                            String metadataEntryName,
                            String metadataEntryValue,
                            ServiceContext serviceContext)
                            throws PortalException,
                                   SystemException

Deprecated. As of 6.2.0, with no direct replacement

Updates the structure matching the structure ID, replacing the metadata entry of the named field.

Parameters:

structureId - the primary key of the structure

fieldName - the name of the field whose metadata to update

metadataEntryName - the metadata entry's name

metadataEntryValue - the metadata entry's value

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

Throws:

PortalException - if a matching structure could not be found, if the XSD was not well-formed, or if a portal exception occurred

SystemException - if a system exception occurred