Liferay 7.0-ce-m3

com.liferay.portlet.dynamicdatamapping.service
Class DDMStructureLocalServiceUtil

java.lang.Object
  extended by com.liferay.portlet.dynamicdatamapping.service.DDMStructureLocalServiceUtil

@ProviderType
public class DDMStructureLocalServiceUtil
extends Object

Provides the local service utility for DDMStructure. This utility wraps com.liferay.portlet.dynamicdatamapping.service.impl.DDMStructureLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. 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:
DDMStructureLocalService, com.liferay.portlet.dynamicdatamapping.service.base.DDMStructureLocalServiceBaseImpl, com.liferay.portlet.dynamicdatamapping.service.impl.DDMStructureLocalServiceImpl

Constructor Summary
DDMStructureLocalServiceUtil()
           
 
Method Summary
static DDMStructure addDDMStructure(DDMStructure ddmStructure)
          Adds the d d m structure to the database.
static void addDLFileEntryTypeDDMStructure(long fileEntryTypeId, DDMStructure ddmStructure)
           
static void addDLFileEntryTypeDDMStructure(long fileEntryTypeId, long structureId)
           
static void addDLFileEntryTypeDDMStructures(long fileEntryTypeId, List<DDMStructure> DDMStructures)
           
static void addDLFileEntryTypeDDMStructures(long fileEntryTypeId, long[] structureIds)
           
static void addJournalFolderDDMStructure(long folderId, DDMStructure ddmStructure)
           
static void addJournalFolderDDMStructure(long folderId, long structureId)
           
static void addJournalFolderDDMStructures(long folderId, List<DDMStructure> DDMStructures)
           
static void addJournalFolderDDMStructures(long folderId, long[] structureIds)
           
static DDMStructure addStructure(long userId, long groupId, long parentStructureId, long classNameId, String structureKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, DDMForm ddmForm, String storageType, int type, ServiceContext serviceContext)
           
static DDMStructure addStructure(long userId, long groupId, long parentStructureId, long classNameId, String structureKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String definition, String storageType, int type, ServiceContext serviceContext)
          Deprecated. As of 7.0.0, replaced by addStructure(long, long, long, long, String, Map, Map, DDMForm, String, int, ServiceContext)
static DDMStructure addStructure(long userId, long groupId, long classNameId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, DDMForm ddmForm, ServiceContext serviceContext)
           
static DDMStructure addStructure(long userId, long groupId, long classNameId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String definition, ServiceContext serviceContext)
          Deprecated. As of 7.0.0, replaced by addStructure(long, long, long, Map, Map, DDMForm, ServiceContext)
static DDMStructure addStructure(long userId, long groupId, String parentStructureKey, long classNameId, String structureKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, DDMForm ddmForm, String storageType, int type, ServiceContext serviceContext)
           
static DDMStructure addStructure(long userId, long groupId, String parentStructureKey, long classNameId, String structureKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String definition, String storageType, int type, ServiceContext serviceContext)
          Deprecated. As of 7.0.0, replaced by addStructure(long, long, String, long, String, Map, Map, DDMForm, String, int, ServiceContext)
static void addStructureResources(DDMStructure structure, boolean addGroupPermissions, boolean addGuestPermissions)
          Adds the resources to the structure.
static void addStructureResources(DDMStructure structure, String[] groupPermissions, String[] guestPermissions)
          Adds the model resources with the permissions to the structure.
static void clearDLFileEntryTypeDDMStructures(long fileEntryTypeId)
           
static void clearJournalFolderDDMStructures(long folderId)
           
static 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.
static DDMStructure copyStructure(long userId, long structureId, ServiceContext serviceContext)
           
static DDMStructure createDDMStructure(long structureId)
          Creates a new d d m structure with the primary key.
static DDMStructure deleteDDMStructure(DDMStructure ddmStructure)
          Deletes the d d m structure from the database.
static DDMStructure deleteDDMStructure(long structureId)
          Deletes the d d m structure with the primary key from the database.
static void deleteDLFileEntryTypeDDMStructure(long fileEntryTypeId, DDMStructure ddmStructure)
           
static void deleteDLFileEntryTypeDDMStructure(long fileEntryTypeId, long structureId)
           
static void deleteDLFileEntryTypeDDMStructures(long fileEntryTypeId, List<DDMStructure> DDMStructures)
           
static void deleteDLFileEntryTypeDDMStructures(long fileEntryTypeId, long[] structureIds)
           
static void deleteJournalFolderDDMStructure(long folderId, DDMStructure ddmStructure)
           
static void deleteJournalFolderDDMStructure(long folderId, long structureId)
           
static void deleteJournalFolderDDMStructures(long folderId, List<DDMStructure> DDMStructures)
           
static void deleteJournalFolderDDMStructures(long folderId, long[] structureIds)
           
static PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
static void deleteStructure(DDMStructure structure)
          Deletes the structure and its resources.
static void deleteStructure(long structureId)
          Deletes the structure and its resources.
static void deleteStructure(long groupId, long classNameId, String structureKey)
          Deletes the matching structure and its resources.
static void deleteStructures(long groupId)
          Deletes all the structures of the group.
static void deleteStructures(long groupId, long classNameId)
           
static DynamicQuery dynamicQuery()
           
static
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)
          Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows matching the dynamic query.
static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows matching the dynamic query.
static DDMStructure fetchDDMStructure(long structureId)
           
static DDMStructure fetchDDMStructureByUuidAndGroupId(String uuid, long groupId)
          Returns the d d m structure matching the UUID and group.
static DDMStructure fetchStructure(long structureId)
          Returns the structure with the ID.
static DDMStructure fetchStructure(long groupId, long classNameId, String structureKey)
          Returns the structure matching the class name ID, structure key, and group.
static DDMStructure fetchStructure(long groupId, long classNameId, 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.
static ActionableDynamicQuery getActionableDynamicQuery()
           
static String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
static List<DDMStructure> getClassStructures(long classNameId)
          Deprecated. As of 6.2.0, replaced by getClassStructures(long, long)
static List<DDMStructure> getClassStructures(long classNameId, int start, int end)
          Deprecated. As of 6.2.0, replaced by getClassStructures(long, long, int, int)
static List<DDMStructure> getClassStructures(long companyId, long classNameId)
          Returns all the structures matching the class name ID.
static List<DDMStructure> getClassStructures(long companyId, long classNameId, int start, int end)
          Returns a range of all the structures matching the class name ID.
static List<DDMStructure> getClassStructures(long companyId, long classNameId, OrderByComparator<DDMStructure> orderByComparator)
          Returns all the structures matching the class name ID ordered by the comparator.
static List<DDMStructure> getClassStructures(long classNameId, OrderByComparator<DDMStructure> orderByComparator)
          Deprecated. As of 6.2.0, replaced by getClassStructures(long, long, OrderByComparator)
static DDMStructure getDDMStructure(long structureId)
          Returns the d d m structure with the primary key.
static DDMStructure getDDMStructureByUuidAndGroupId(String uuid, long groupId)
          Returns the d d m structure matching the UUID and group.
static List<DDMStructure> getDDMStructures(int start, int end)
          Returns a range of all the d d m structures.
static List<DDMStructure> getDDMStructuresByUuidAndCompanyId(String uuid, long companyId)
          Returns all the d d m structures matching the UUID and company.
static List<DDMStructure> getDDMStructuresByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<DDMStructure> orderByComparator)
          Returns a range of d d m structures matching the UUID and company.
static int getDDMStructuresCount()
          Returns the number of d d m structures.
static List<DDMStructure> getDLFileEntryTypeDDMStructures(long fileEntryTypeId)
           
static List<DDMStructure> getDLFileEntryTypeDDMStructures(long fileEntryTypeId, int start, int end)
           
static List<DDMStructure> getDLFileEntryTypeDDMStructures(long fileEntryTypeId, int start, int end, OrderByComparator<DDMStructure> orderByComparator)
           
static int getDLFileEntryTypeDDMStructuresCount(long fileEntryTypeId)
           
static long[] getDLFileEntryTypePrimaryKeys(long structureId)
          Returns the fileEntryTypeIds of the document library file entry types associated with the d d m structure.
static List<DDMStructure> getDLFileEntryTypeStructures(long dlFileEntryTypeId)
          Returns all the structures for the document library file entry type.
static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
           
static List<DDMStructure> getJournalFolderDDMStructures(long folderId)
           
static List<DDMStructure> getJournalFolderDDMStructures(long folderId, int start, int end)
           
static List<DDMStructure> getJournalFolderDDMStructures(long folderId, int start, int end, OrderByComparator<DDMStructure> orderByComparator)
           
static int getJournalFolderDDMStructuresCount(long folderId)
           
static long[] getJournalFolderPrimaryKeys(long structureId)
          Returns the folderIds of the journal folders associated with the d d m structure.
static List<DDMStructure> getJournalFolderStructures(long[] groupIds, long journalFolderId, int restrictionType)
           
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static DDMStructureLocalService getService()
           
static DDMStructure getStructure(long structureId)
          Returns the structure with the ID.
static DDMStructure getStructure(long groupId, long classNameId, String structureKey)
          Returns the structure matching the class name ID, structure key, and group.
static DDMStructure getStructure(long groupId, long classNameId, 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.
static List<DDMStructure> getStructure(long groupId, String name, String description)
          Returns all the structures matching the group, name, and description.
static List<DDMStructure> getStructureEntries()
          Deprecated. As of 6.2.0, replaced by getStructures()
static List<DDMStructure> getStructureEntries(long groupId)
          Deprecated. As of 6.2.0, replaced by getStructures(long)
static List<DDMStructure> getStructureEntries(long groupId, int start, int end)
          Deprecated. As of 6.2.0, replaced by getStructures(long, int, int)
static List<DDMStructure> getStructures()
          Returns all the structures present in the system.
static List<DDMStructure> getStructures(long groupId)
          Returns all the structures present in the group.
static List<DDMStructure> getStructures(long[] groupIds)
          Returns all the structures belonging to the groups.
static List<DDMStructure> getStructures(long[] groupIds, long classNameId)
          Returns all the structures matching the class name ID and belonging to the groups.
static 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.
static List<DDMStructure> getStructures(long groupId, int start, int end)
          Returns a range of all the structures belonging to the group.
static List<DDMStructure> getStructures(long groupId, long classNameId)
          Returns all the structures matching class name ID and group.
static 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.
static List<DDMStructure> getStructures(long groupId, long classNameId, int start, int end, OrderByComparator<DDMStructure> orderByComparator)
          Returns an ordered range of all the structures matching the class name ID and group.
static List<DDMStructure> getStructures(long groupId, String name, String description)
           
static int getStructuresCount(long groupId)
          Returns the number of structures belonging to the group.
static int getStructuresCount(long[] groupIds, long classNameId)
          Returns the number of structures matching the class name ID and belonging to the groups.
static int getStructuresCount(long groupId, long classNameId)
          Returns the number of structures matching the class name ID and group.
static boolean hasDLFileEntryTypeDDMStructure(long fileEntryTypeId, long structureId)
           
static boolean hasDLFileEntryTypeDDMStructures(long fileEntryTypeId)
           
static boolean hasJournalFolderDDMStructure(long folderId, long structureId)
           
static boolean hasJournalFolderDDMStructures(long folderId)
           
static List<DDMStructure> search(long companyId, long[] groupIds, long[] classNameIds, String keywords, int start, int end, 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.
static List<DDMStructure> search(long companyId, long[] groupIds, long[] classNameIds, String name, String description, String storageType, int type, boolean andOperator, int start, int end, 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.
static 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.
static 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
static void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
static void setDLFileEntryTypeDDMStructures(long fileEntryTypeId, long[] structureIds)
           
static void setJournalFolderDDMStructures(long folderId, long[] structureIds)
           
 void setService(DDMStructureLocalService service)
          Deprecated. As of 6.2.0
static DDMStructure updateDDMForm(long structureId, DDMForm ddmForm, ServiceContext serviceContext)
           
static DDMStructure updateDDMStructure(DDMStructure ddmStructure)
          Updates the d d m structure in the database or adds it if it does not yet exist.
static DDMStructure updateStructure(long groupId, long parentStructureId, long classNameId, String structureKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, DDMForm ddmForm, ServiceContext serviceContext)
           
static DDMStructure updateStructure(long groupId, long parentStructureId, long classNameId, String structureKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String definition, ServiceContext serviceContext)
          Deprecated. As of 7.0.0, replaced by updateStructure(long, long, long, String, Map, Map, DDMForm, ServiceContext)
static DDMStructure updateStructure(long structureId, long parentStructureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, DDMForm ddmForm, ServiceContext serviceContext)
           
static DDMStructure updateStructure(long structureId, long parentStructureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String definition, ServiceContext serviceContext)
          Deprecated. As of 7.0.0, replaced by updateStructure(long, long, Map, Map, DDMForm, ServiceContext)
static DDMStructure updateXSD(long structureId, String definition, ServiceContext serviceContext)
          Deprecated. As of 7.0.0, replaced by #updateDDMForm(long, String, ServiceContext)
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DDMStructureLocalServiceUtil

public DDMStructureLocalServiceUtil()
Method Detail

addDDMStructure

public static DDMStructure addDDMStructure(DDMStructure ddmStructure)
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

addDLFileEntryTypeDDMStructure

public static void addDLFileEntryTypeDDMStructure(long fileEntryTypeId,
                                                  DDMStructure ddmStructure)

addDLFileEntryTypeDDMStructure

public static void addDLFileEntryTypeDDMStructure(long fileEntryTypeId,
                                                  long structureId)

addDLFileEntryTypeDDMStructures

public static void addDLFileEntryTypeDDMStructures(long fileEntryTypeId,
                                                   List<DDMStructure> DDMStructures)

addDLFileEntryTypeDDMStructures

public static void addDLFileEntryTypeDDMStructures(long fileEntryTypeId,
                                                   long[] structureIds)

addJournalFolderDDMStructure

public static void addJournalFolderDDMStructure(long folderId,
                                                DDMStructure ddmStructure)

addJournalFolderDDMStructure

public static void addJournalFolderDDMStructure(long folderId,
                                                long structureId)

addJournalFolderDDMStructures

public static void addJournalFolderDDMStructures(long folderId,
                                                 List<DDMStructure> DDMStructures)

addJournalFolderDDMStructures

public static void addJournalFolderDDMStructures(long folderId,
                                                 long[] structureIds)

addStructure

public static DDMStructure addStructure(long userId,
                                        long groupId,
                                        long classNameId,
                                        Map<Locale,String> nameMap,
                                        Map<Locale,String> descriptionMap,
                                        DDMForm ddmForm,
                                        ServiceContext serviceContext)
                                 throws PortalException
Throws:
PortalException

addStructure

@Deprecated
public static DDMStructure addStructure(long userId,
                                                   long groupId,
                                                   long classNameId,
                                                   Map<Locale,String> nameMap,
                                                   Map<Locale,String> descriptionMap,
                                                   String definition,
                                                   ServiceContext serviceContext)
                                 throws PortalException
Deprecated. As of 7.0.0, replaced by addStructure(long, long, long, Map, Map, DDMForm, 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:
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

addStructure

public static DDMStructure addStructure(long userId,
                                        long groupId,
                                        long parentStructureId,
                                        long classNameId,
                                        String structureKey,
                                        Map<Locale,String> nameMap,
                                        Map<Locale,String> descriptionMap,
                                        DDMForm ddmForm,
                                        String storageType,
                                        int type,
                                        ServiceContext serviceContext)
                                 throws PortalException
Throws:
PortalException

addStructure

@Deprecated
public static DDMStructure addStructure(long userId,
                                                   long groupId,
                                                   long parentStructureId,
                                                   long classNameId,
                                                   String structureKey,
                                                   Map<Locale,String> nameMap,
                                                   Map<Locale,String> descriptionMap,
                                                   String definition,
                                                   String storageType,
                                                   int type,
                                                   ServiceContext serviceContext)
                                 throws PortalException
Deprecated. As of 7.0.0, replaced by addStructure(long, long, long, long, String, Map, Map, DDMForm, 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:
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

addStructure

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

addStructure

@Deprecated
public static DDMStructure addStructure(long userId,
                                                   long groupId,
                                                   String parentStructureKey,
                                                   long classNameId,
                                                   String structureKey,
                                                   Map<Locale,String> nameMap,
                                                   Map<Locale,String> descriptionMap,
                                                   String definition,
                                                   String storageType,
                                                   int type,
                                                   ServiceContext serviceContext)
                                 throws PortalException
Deprecated. As of 7.0.0, replaced by addStructure(long, long, String, long, String, Map, Map, DDMForm, 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:
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

addStructureResources

public static void addStructureResources(DDMStructure structure,
                                         boolean addGroupPermissions,
                                         boolean addGuestPermissions)
                                  throws 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:
PortalException - if a portal exception occurred

addStructureResources

public static void addStructureResources(DDMStructure structure,
                                         String[] groupPermissions,
                                         String[] guestPermissions)
                                  throws PortalException
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

clearDLFileEntryTypeDDMStructures

public static void clearDLFileEntryTypeDDMStructures(long fileEntryTypeId)

clearJournalFolderDDMStructures

public static void clearJournalFolderDDMStructures(long folderId)

copyStructure

public static DDMStructure copyStructure(long userId,
                                         long structureId,
                                         Map<Locale,String> nameMap,
                                         Map<Locale,String> descriptionMap,
                                         ServiceContext serviceContext)
                                  throws 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:
PortalException - if a portal exception occurred

copyStructure

public static DDMStructure copyStructure(long userId,
                                         long structureId,
                                         ServiceContext serviceContext)
                                  throws PortalException
Throws:
PortalException

createDDMStructure

public static 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

public static DDMStructure deleteDDMStructure(DDMStructure ddmStructure)
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

deleteDDMStructure

public static DDMStructure deleteDDMStructure(long structureId)
                                       throws PortalException
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

deleteDLFileEntryTypeDDMStructure

public static void deleteDLFileEntryTypeDDMStructure(long fileEntryTypeId,
                                                     DDMStructure ddmStructure)

deleteDLFileEntryTypeDDMStructure

public static void deleteDLFileEntryTypeDDMStructure(long fileEntryTypeId,
                                                     long structureId)

deleteDLFileEntryTypeDDMStructures

public static void deleteDLFileEntryTypeDDMStructures(long fileEntryTypeId,
                                                      List<DDMStructure> DDMStructures)

deleteDLFileEntryTypeDDMStructures

public static void deleteDLFileEntryTypeDDMStructures(long fileEntryTypeId,
                                                      long[] structureIds)

deleteJournalFolderDDMStructure

public static void deleteJournalFolderDDMStructure(long folderId,
                                                   DDMStructure ddmStructure)

deleteJournalFolderDDMStructure

public static void deleteJournalFolderDDMStructure(long folderId,
                                                   long structureId)

deleteJournalFolderDDMStructures

public static void deleteJournalFolderDDMStructures(long folderId,
                                                    List<DDMStructure> DDMStructures)

deleteJournalFolderDDMStructures

public static void deleteJournalFolderDDMStructures(long folderId,
                                                    long[] structureIds)

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException
Throws:
PortalException

deleteStructure

public static void deleteStructure(long groupId,
                                   long classNameId,
                                   String structureKey)
                            throws 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:
PortalException - if a portal exception occurred

deleteStructure

public static void deleteStructure(DDMStructure structure)
                            throws 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:
PortalException - if a portal exception occurred

deleteStructure

public static void deleteStructure(long structureId)
                            throws 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:
PortalException - if a portal exception occurred

deleteStructures

public static void deleteStructures(long groupId)
                             throws 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:
PortalException - if a portal exception occurred

deleteStructures

public static void deleteStructures(long groupId,
                                    long classNameId)
                             throws PortalException
Throws:
PortalException

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows

dynamicQuery

public static <T> List<T> dynamicQuery(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 com.liferay.portlet.dynamicdatamapping.model.impl.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

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                       int start,
                                       int end,
                                       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 com.liferay.portlet.dynamicdatamapping.model.impl.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

dynamicQueryCount

public static long dynamicQueryCount(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

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     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

fetchDDMStructure

public static DDMStructure fetchDDMStructure(long structureId)

fetchDDMStructureByUuidAndGroupId

public static DDMStructure fetchDDMStructureByUuidAndGroupId(String uuid,
                                                             long groupId)
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

fetchStructure

public static DDMStructure fetchStructure(long groupId,
                                          long classNameId,
                                          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

public static DDMStructure fetchStructure(long groupId,
                                          long classNameId,
                                          String structureKey,
                                          boolean includeAncestorStructures)
                                   throws 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:
PortalException - if a portal exception occurred

fetchStructure

public static 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

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getBeanIdentifier

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

Returns:
the Spring bean ID for this bean

getClassStructures

@Deprecated
public static List<DDMStructure> getClassStructures(long classNameId)
Deprecated. As of 6.2.0, replaced by getClassStructures(long, long)


getClassStructures

@Deprecated
public static List<DDMStructure> getClassStructures(long classNameId,
                                                               OrderByComparator<DDMStructure> orderByComparator)
Deprecated. As of 6.2.0, replaced by getClassStructures(long, long, OrderByComparator)


getClassStructures

@Deprecated
public static List<DDMStructure> getClassStructures(long classNameId,
                                                               int start,
                                                               int end)
Deprecated. As of 6.2.0, replaced by getClassStructures(long, long, int, int)


getClassStructures

public static 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

public static List<DDMStructure> getClassStructures(long companyId,
                                                    long classNameId,
                                                    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

public static 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

getDDMStructure

public static DDMStructure getDDMStructure(long structureId)
                                    throws PortalException
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

getDDMStructureByUuidAndGroupId

public static DDMStructure getDDMStructureByUuidAndGroupId(String uuid,
                                                           long groupId)
                                                    throws PortalException
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

getDDMStructures

public static List<DDMStructure> getDDMStructures(int start,
                                                  int end)
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 com.liferay.portlet.dynamicdatamapping.model.impl.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

getDDMStructuresByUuidAndCompanyId

public static List<DDMStructure> getDDMStructuresByUuidAndCompanyId(String uuid,
                                                                    long companyId)
Returns all the d d m structures matching the UUID and company.

Parameters:
uuid - the UUID of the d d m structures
companyId - the primary key of the company
Returns:
the matching d d m structures, or an empty list if no matches were found

getDDMStructuresByUuidAndCompanyId

public static List<DDMStructure> getDDMStructuresByUuidAndCompanyId(String uuid,
                                                                    long companyId,
                                                                    int start,
                                                                    int end,
                                                                    OrderByComparator<DDMStructure> orderByComparator)
Returns a range of d d m structures matching the UUID and company.

Parameters:
uuid - the UUID of the d d m structures
companyId - the primary key of the company
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)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the range of matching d d m structures, or an empty list if no matches were found

getDDMStructuresCount

public static int getDDMStructuresCount()
Returns the number of d d m structures.

Returns:
the number of d d m structures

getDLFileEntryTypeDDMStructures

public static List<DDMStructure> getDLFileEntryTypeDDMStructures(long fileEntryTypeId)

getDLFileEntryTypeDDMStructures

public static List<DDMStructure> getDLFileEntryTypeDDMStructures(long fileEntryTypeId,
                                                                 int start,
                                                                 int end)

getDLFileEntryTypeDDMStructures

public static List<DDMStructure> getDLFileEntryTypeDDMStructures(long fileEntryTypeId,
                                                                 int start,
                                                                 int end,
                                                                 OrderByComparator<DDMStructure> orderByComparator)

getDLFileEntryTypeDDMStructuresCount

public static int getDLFileEntryTypeDDMStructuresCount(long fileEntryTypeId)

getDLFileEntryTypePrimaryKeys

public static long[] getDLFileEntryTypePrimaryKeys(long structureId)
Returns the fileEntryTypeIds of the document library file entry types associated with the d d m structure.

Parameters:
structureId - the structureId of the d d m structure
Returns:
long[] the fileEntryTypeIds of document library file entry types associated with the d d m structure

getDLFileEntryTypeStructures

public static List<DDMStructure> getDLFileEntryTypeStructures(long dlFileEntryTypeId)
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

getExportActionableDynamicQuery

public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getJournalFolderDDMStructures

public static List<DDMStructure> getJournalFolderDDMStructures(long folderId)

getJournalFolderDDMStructures

public static List<DDMStructure> getJournalFolderDDMStructures(long folderId,
                                                               int start,
                                                               int end)

getJournalFolderDDMStructures

public static List<DDMStructure> getJournalFolderDDMStructures(long folderId,
                                                               int start,
                                                               int end,
                                                               OrderByComparator<DDMStructure> orderByComparator)

getJournalFolderDDMStructuresCount

public static int getJournalFolderDDMStructuresCount(long folderId)

getJournalFolderPrimaryKeys

public static long[] getJournalFolderPrimaryKeys(long structureId)
Returns the folderIds of the journal folders associated with the d d m structure.

Parameters:
structureId - the structureId of the d d m structure
Returns:
long[] the folderIds of journal folders associated with the d d m structure

getJournalFolderStructures

public static List<DDMStructure> getJournalFolderStructures(long[] groupIds,
                                                            long journalFolderId,
                                                            int restrictionType)
                                                     throws PortalException
Throws:
PortalException

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException
Throws:
PortalException

getStructure

public static DDMStructure getStructure(long groupId,
                                        long classNameId,
                                        String structureKey)
                                 throws 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:
PortalException - if a matching structure could not be found

getStructure

public static DDMStructure getStructure(long groupId,
                                        long classNameId,
                                        String structureKey,
                                        boolean includeAncestorStructures)
                                 throws 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:
PortalException - if a matching structure could not be found

getStructure

public static List<DDMStructure> getStructure(long groupId,
                                              String name,
                                              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

getStructure

public static DDMStructure getStructure(long structureId)
                                 throws PortalException
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

getStructureEntries

@Deprecated
public static List<DDMStructure> getStructureEntries()
Deprecated. As of 6.2.0, replaced by getStructures()


getStructureEntries

@Deprecated
public static List<DDMStructure> getStructureEntries(long groupId)
Deprecated. As of 6.2.0, replaced by getStructures(long)


getStructureEntries

@Deprecated
public static List<DDMStructure> getStructureEntries(long groupId,
                                                                int start,
                                                                int end)
Deprecated. As of 6.2.0, replaced by getStructures(long, int, int)


getStructures

public static List<DDMStructure> getStructures()
Returns all the structures present in the system.

Returns:
the structures present in the system

getStructures

public static 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

public static 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

public static 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

public static List<DDMStructure> getStructures(long groupId,
                                               long classNameId,
                                               int start,
                                               int end,
                                               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

public static List<DDMStructure> getStructures(long groupId,
                                               String name,
                                               String description)

getStructures

public static 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

public static 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

public static 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

public static 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

getStructuresCount

public static 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

public static 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

public static 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

hasDLFileEntryTypeDDMStructure

public static boolean hasDLFileEntryTypeDDMStructure(long fileEntryTypeId,
                                                     long structureId)

hasDLFileEntryTypeDDMStructures

public static boolean hasDLFileEntryTypeDDMStructures(long fileEntryTypeId)

hasJournalFolderDDMStructure

public static boolean hasJournalFolderDDMStructure(long folderId,
                                                   long structureId)

hasJournalFolderDDMStructures

public static boolean hasJournalFolderDDMStructures(long folderId)

search

public static List<DDMStructure> search(long companyId,
                                        long[] groupIds,
                                        long[] classNameIds,
                                        String keywords,
                                        int start,
                                        int end,
                                        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
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

search

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

searchCount

public static 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.

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

searchCount

public static 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

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

setBeanIdentifier

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

Parameters:
beanIdentifier - the Spring bean ID for this bean

setDLFileEntryTypeDDMStructures

public static void setDLFileEntryTypeDDMStructures(long fileEntryTypeId,
                                                   long[] structureIds)

setJournalFolderDDMStructures

public static void setJournalFolderDDMStructures(long folderId,
                                                 long[] structureIds)

updateDDMForm

public static DDMStructure updateDDMForm(long structureId,
                                         DDMForm ddmForm,
                                         ServiceContext serviceContext)
                                  throws PortalException
Throws:
PortalException

updateDDMStructure

public static DDMStructure updateDDMStructure(DDMStructure ddmStructure)
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

updateStructure

public static DDMStructure updateStructure(long groupId,
                                           long parentStructureId,
                                           long classNameId,
                                           String structureKey,
                                           Map<Locale,String> nameMap,
                                           Map<Locale,String> descriptionMap,
                                           DDMForm ddmForm,
                                           ServiceContext serviceContext)
                                    throws PortalException
Throws:
PortalException

updateStructure

@Deprecated
public static DDMStructure updateStructure(long groupId,
                                                      long parentStructureId,
                                                      long classNameId,
                                                      String structureKey,
                                                      Map<Locale,String> nameMap,
                                                      Map<Locale,String> descriptionMap,
                                                      String definition,
                                                      ServiceContext serviceContext)
                                    throws PortalException
Deprecated. As of 7.0.0, replaced by updateStructure(long, long, long, String, Map, Map, DDMForm, 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:
PortalException - if a matching structure could not be found, if the XSD was not well-formed, or if a portal exception occurred

updateStructure

public static DDMStructure updateStructure(long structureId,
                                           long parentStructureId,
                                           Map<Locale,String> nameMap,
                                           Map<Locale,String> descriptionMap,
                                           DDMForm ddmForm,
                                           ServiceContext serviceContext)
                                    throws PortalException
Throws:
PortalException

updateStructure

@Deprecated
public static DDMStructure updateStructure(long structureId,
                                                      long parentStructureId,
                                                      Map<Locale,String> nameMap,
                                                      Map<Locale,String> descriptionMap,
                                                      String definition,
                                                      ServiceContext serviceContext)
                                    throws PortalException
Deprecated. As of 7.0.0, replaced by updateStructure(long, long, Map, Map, DDMForm, 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:
PortalException - if a matching structure could not be found, if the XSD was not well-formed, or if a portal exception occurred

updateXSD

@Deprecated
public static DDMStructure updateXSD(long structureId,
                                                String definition,
                                                ServiceContext serviceContext)
                              throws PortalException
Deprecated. As of 7.0.0, replaced by #updateDDMForm(long, String, 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:
PortalException - if a matching structure could not be found, if the XSD was not well-formed, or if a portal exception occurred

getService

public static DDMStructureLocalService getService()

setService

@Deprecated
public void setService(DDMStructureLocalService service)
Deprecated. As of 6.2.0


Liferay 7.0-ce-m3