Class DDMStructureLocalServiceUtil

java.lang.Object
com.liferay.dynamic.data.mapping.service.DDMStructureLocalServiceUtil

public class DDMStructureLocalServiceUtil extends Object
Provides the local service utility for DDMStructure. This utility wraps com.liferay.dynamic.data.mapping.service.impl.DDMStructureLocalServiceImpl and is an 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:
Generated:
  • Constructor Details

    • DDMStructureLocalServiceUtil

      public DDMStructureLocalServiceUtil()
  • Method Details

    • addDDMStructure

      public static DDMStructure addDDMStructure(DDMStructure ddmStructure)
      Adds the ddm structure to the database. Also notifies the appropriate model listeners.

      Important: Inspect DDMStructureLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      ddmStructure - the ddm structure
      Returns:
      the ddm structure that was added
    • addStructure

      public static DDMStructure addStructure(long userId, long groupId, long classNameId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, DDMForm ddmForm, DDMFormLayout ddmFormLayout, String storageType, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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, DDMFormLayout ddmFormLayout, String storageType, int type, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addStructure

      public static DDMStructure addStructure(String externalReferenceCode, long userId, long groupId, long parentStructureId, long classNameId, String structureKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, DDMForm ddmForm, DDMFormLayout ddmFormLayout, String storageType, int type, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addStructure

      public static DDMStructure addStructure(String externalReferenceCode, long userId, long groupId, long parentStructureId, long classNameId, String structureKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String definition, String storageType, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addStructureResources

      public static void addStructureResources(DDMStructure structure, boolean addGroupPermissions, boolean addGuestPermissions) throws com.liferay.portal.kernel.exception.PortalException
      Adds the resources to the structure.
      Parameters:
      structure - the structure to add resources to
      addGroupPermissions - whether to add group permissions
      addGuestPermissions - whether to add guest permissions
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addStructureResources

      public static void addStructureResources(DDMStructure structure, com.liferay.portal.kernel.service.permission.ModelPermissions modelPermissions) throws com.liferay.portal.kernel.exception.PortalException
      Adds the model resources with the permissions to the structure.
      Parameters:
      structure - the structure to add resources to
      modelPermissions - the model permissions to be added
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • copyStructure

      public static DDMStructure copyStructure(long userId, long sourceStructureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Copies a structure, creating a new structure with all the values extracted from the original one. The new structure supports a new name and description.
      Parameters:
      userId - the primary key of the structure's creator/owner
      sourceStructureId - the primary key of the structure to be copied
      nameMap - the new structure's locales and localized names
      descriptionMap - the new structure's locales and localized descriptions
      serviceContext - the service context to be applied. Can set the UUID, creation date, modification date, guest permissions, and group permissions for the structure.
      Returns:
      the new structure
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • copyStructure

      public static DDMStructure copyStructure(long userId, long sourceStructureId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createDDMStructure

      public static DDMStructure createDDMStructure(long structureId)
      Creates a new ddm structure with the primary key. Does not add the ddm structure to the database.
      Parameters:
      structureId - the primary key for the new ddm structure
      Returns:
      the new ddm structure
    • createPersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteDDMStructure

      public static DDMStructure deleteDDMStructure(DDMStructure ddmStructure)
      Deletes the ddm structure from the database. Also notifies the appropriate model listeners.

      Important: Inspect DDMStructureLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      ddmStructure - the ddm structure
      Returns:
      the ddm structure that was removed
    • deleteDDMStructure

      public static DDMStructure deleteDDMStructure(long structureId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the ddm structure with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect DDMStructureLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      structureId - the primary key of the ddm structure
      Returns:
      the ddm structure that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a ddm structure with the primary key could not be found
    • deletePersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteStructure

      public static DDMStructure deleteStructure(DDMStructure structure) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the structure and its resources.

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

      Parameters:
      structure - the structure to be deleted
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteStructure

      public static void deleteStructure(long structureId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the structure and its resources.

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

      Parameters:
      structureId - the primary key of the structure to be deleted
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteStructure

      public static void deleteStructure(long groupId, long classNameId, String structureKey) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the matching structure and its resources.

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

      Parameters:
      groupId - the primary key of the group
      classNameId - the primary key of the class name for the structure's related model
      structureKey - the unique string identifying the structure
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteStructures

      public static void deleteStructures(long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes all the structures of the group.

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

      Parameters:
      groupId - the primary key of the group
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteStructures

      public static void deleteStructures(long groupId, long classNameId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • dslQuery

      public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dslQueryCount

      public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dynamicQuery

      public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
      Performs a dynamic query on the database and returns the matching rows.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the matching rows
    • dynamicQuery

      public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end)
      Performs a dynamic query on the database and returns a range of the matching rows.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.dynamic.data.mapping.model.impl.DDMStructureModelImpl.

      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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
      Performs a dynamic query on the database and returns an ordered range of the matching rows.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.dynamic.data.mapping.model.impl.DDMStructureModelImpl.

      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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
      Returns the number of rows matching the dynamic query.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the number of rows matching the dynamic query
    • dynamicQueryCount

      public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
      Returns the number of rows matching the dynamic query.
      Parameters:
      dynamicQuery - the dynamic query
      projection - the projection to apply to the query
      Returns:
      the number of rows matching the dynamic query
    • fetchDDMStructure

      public static DDMStructure fetchDDMStructure(long structureId)
    • fetchDDMStructureByUuidAndGroupId

      public static DDMStructure fetchDDMStructureByUuidAndGroupId(String uuid, long groupId)
      Returns the ddm structure matching the UUID and group.
      Parameters:
      uuid - the ddm structure's UUID
      groupId - the primary key of the group
      Returns:
      the matching ddm structure, or null if a matching ddm structure could not be found
    • fetchStructure

      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
    • 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)
      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
    • fetchStructureByExternalReferenceCode

      public static DDMStructure fetchStructureByExternalReferenceCode(String externalReferenceCode, long groupId, long classNameId)
    • fetchStructureByUuidAndGroupId

      public static DDMStructure fetchStructureByUuidAndGroupId(String uuid, long groupId, boolean includeAncestorStructures)
    • getActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getChildrenStructures

      public static List<DDMStructure> getChildrenStructures(long parentStructureId)
    • 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, 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
    • getClassStructures

      public static List<DDMStructure> getClassStructures(long companyId, long classNameId, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator)
      Returns all the structures matching the class name ID ordered by the comparator.
      Parameters:
      companyId - the primary key of the structure's company
      classNameId - the primary key of the class name for the structure's related model
      orderByComparator - the comparator to order the structures (optionally null)
      Returns:
      the matching structures ordered by the comparator
    • getDDMStructure

      public static DDMStructure getDDMStructure(long structureId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the ddm structure with the primary key.
      Parameters:
      structureId - the primary key of the ddm structure
      Returns:
      the ddm structure
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a ddm structure with the primary key could not be found
    • getDDMStructureByUuidAndGroupId

      public static DDMStructure getDDMStructureByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the ddm structure matching the UUID and group.
      Parameters:
      uuid - the ddm structure's UUID
      groupId - the primary key of the group
      Returns:
      the matching ddm structure
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching ddm structure could not be found
    • getDDMStructures

      public static List<DDMStructure> getDDMStructures(int start, int end)
      Returns a range of all the ddm structures.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.dynamic.data.mapping.model.impl.DDMStructureModelImpl.

      Parameters:
      start - the lower bound of the range of ddm structures
      end - the upper bound of the range of ddm structures (not inclusive)
      Returns:
      the range of ddm structures
    • getDDMStructuresByUuidAndCompanyId

      public static List<DDMStructure> getDDMStructuresByUuidAndCompanyId(String uuid, long companyId)
      Returns all the ddm structures matching the UUID and company.
      Parameters:
      uuid - the UUID of the ddm structures
      companyId - the primary key of the company
      Returns:
      the matching ddm structures, or an empty list if no matches were found
    • getDDMStructuresByUuidAndCompanyId

      public static List<DDMStructure> getDDMStructuresByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator)
      Returns a range of ddm structures matching the UUID and company.
      Parameters:
      uuid - the UUID of the ddm structures
      companyId - the primary key of the company
      start - the lower bound of the range of ddm structures
      end - the upper bound of the range of ddm structures (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the range of matching ddm structures, or an empty list if no matches were found
    • getDDMStructuresCount

      public static int getDDMStructuresCount()
      Returns the number of ddm structures.
      Returns:
      the number of ddm structures
    • getExportActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

      public static String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getStructure

      public static DDMStructure getStructure(long structureId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the structure with the ID.
      Parameters:
      structureId - the primary key of the structure
      Returns:
      the structure with the ID
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getStructure

      public static DDMStructure getStructure(long groupId, long classNameId, String structureKey) throws com.liferay.portal.kernel.exception.PortalException
      Returns the structure matching the class name ID, structure key, and group.
      Parameters:
      groupId - the primary key of the structure's group
      classNameId - the primary key of the class name for the structure's related model
      structureKey - the unique string identifying the structure
      Returns:
      the matching structure
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getStructure

      public static DDMStructure getStructure(long groupId, long classNameId, String structureKey, boolean includeAncestorStructures) throws com.liferay.portal.kernel.exception.PortalException
      Returns the structure matching the class name ID, structure key, and group, optionally searching ancestor sites (that have sharing enabled) and global scoped sites.

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

      Parameters:
      groupId - the primary key of the structure's group
      classNameId - the primary key of the class name for the structure's related model
      structureKey - the unique string identifying the structure
      includeAncestorStructures - whether to include ancestor sites (that have sharing enabled) and include global scoped sites in the search in the search
      Returns:
      the matching structure
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getStructure

      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
    • getStructureByExternalReferenceCode

      public static DDMStructure getStructureByExternalReferenceCode(String externalReferenceCode, long groupId, long classNameId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getStructureDDMForm

      public static DDMForm getStructureDDMForm(DDMStructure structure) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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, 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 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, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator)
      Returns an ordered range of all the structures matching the class name ID and group.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.

      Parameters:
      groupId - the primary key of the group
      classNameId - the primary key of the class name for the structure's related model
      start - the lower bound of the range of structures to return
      end - the upper bound of the range of structures to return (not inclusive)
      orderByComparator - the comparator to order the structures (optionally null)
      Returns:
      the range of matching structures ordered by the comparator
    • getStructures

      public static List<DDMStructure> getStructures(long companyId, long[] groupIds, long classNameId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator)
    • getStructures

      public static List<DDMStructure> getStructures(long companyId, long[] groupIds, long classNameId, String keywords, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator)
    • getStructures

      public static List<DDMStructure> getStructures(long groupId, String name, String description)
    • 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
    • getStructures

      public static List<DDMStructure> getStructures(long[] groupIds, long classNameId, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator)
    • getStructures

      public static List<DDMStructure> getStructures(long[] groupIds, long classNameId, String name, String description, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator)
      Returns an ordered range of all the structures matching the group, class name ID, name, and description.

      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
      name - the name keywords
      description - the description keywords
      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
    • 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 companyId, long[] groupIds, long classNameId, String keywords, int status)
    • 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
    • hasStructure

      public static boolean hasStructure(long groupId, long classNameId, String structureKey)
    • prepareLocalizedDefinitionForImport

      public static String prepareLocalizedDefinitionForImport(DDMStructure structure, Locale defaultImportLocale)
    • revertStructure

      public static void revertStructure(long userId, long structureId, String version, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • search

      public static List<DDMStructure> search(long companyId, long[] groupIds, long classNameId, long classPK, String keywords, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • search

      public static List<DDMStructure> search(long companyId, long[] groupIds, long classNameId, String keywords, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator)
      Returns an ordered range of all the structures matching the groups and class name IDs, and matching the keywords in the structure names and descriptions.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.

      Parameters:
      companyId - the primary key of the structure's company
      groupIds - the primary keys of the groups
      classNameId - the primary key of the class name of the model the structure is related to
      keywords - the keywords (space separated), which may occur in the structure's name or description (optionally null)
      start - the lower bound of the range of structures to return
      end - the upper bound of the range of structures to return (not inclusive)
      orderByComparator - the comparator to order the structures (optionally null)
      Returns:
      the range of matching structures ordered by the comparator
    • search

      public static List<DDMStructure> search(long companyId, long[] groupIds, long classNameId, String name, String description, String storageType, int type, int status, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator)
      Returns an ordered range of all the structures matching the groups, class name IDs, name keyword, description keyword, storage type, and type.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.

      Parameters:
      companyId - the primary key of the structure's company
      groupIds - the primary keys of the groups
      classNameId - the primary key of the class name of the model the structure is related to
      name - the name keywords
      description - the description keywords
      storageType - the structure's storage type. It can be "xml" or "expando". For more information, see StorageType.
      type - the structure's type. For more information, see DDMStructureConstants.
      andOperator - whether every field must match its keywords, or just one field
      start - the lower bound of the range of structures to return
      end - the upper bound of the range of structures to return (not inclusive)
      orderByComparator - the comparator to order the structures (optionally null)
      Returns:
      the range of matching structures ordered by the comparator
    • searchCount

      public static int searchCount(long companyId, long[] groupIds, long classNameId, long classPK, String keywords) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • searchCount

      public static int searchCount(long companyId, long[] groupIds, long classNameId, String keywords, int status)
      Returns the number of structures matching the groups and class name IDs, and matching the keywords in the structure names and descriptions.
      Parameters:
      companyId - the primary key of the structure's company
      groupIds - the primary keys of the groups
      classNameId - the primary key of the class name of the model the structure is related to
      keywords - the keywords (space separated), which may occur in the structure's name or description (optionally null)
      Returns:
      the number of matching structures
    • searchCount

      public static int searchCount(long companyId, long[] groupIds, long classNameId, String name, String description, String storageType, int type, int status, boolean andOperator)
      Returns the number of structures matching the groups, class name IDs, name keyword, description keyword, storage type, and type
      Parameters:
      companyId - the primary key of the structure's company
      groupIds - the primary keys of the groups
      classNameId -
      name - the name keywords
      description - the description keywords
      storageType - the structure's storage type. It can be "xml" or "expando". For more information, see StorageType.
      type - the structure's type. For more information, see DDMStructureConstants.
      andOperator - whether every field must match its keywords, or just one field
      Returns:
      the number of matching structures
    • updateDDMStructure

      public static DDMStructure updateDDMStructure(DDMStructure ddmStructure)
      Updates the ddm structure in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect DDMStructureLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      ddmStructure - the ddm structure
      Returns:
      the ddm structure that was updated
    • updateStructure

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

      public static DDMStructure updateStructure(long userId, long groupId, long parentStructureId, long classNameId, String structureKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, DDMForm ddmForm, DDMFormLayout ddmFormLayout, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateStructure

      public static DDMStructure updateStructure(long userId, long structureId, long parentStructureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, DDMForm ddmForm, DDMFormLayout ddmFormLayout, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateStructure

      public static DDMStructure updateStructure(String externalReferenceCode, long userId, long structureId, long groupId, long parentStructureId, long classNameId, String structureKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String definition, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static DDMStructureLocalService getService()