Interface DDMStructureService

All Superinterfaces:
com.liferay.portal.kernel.service.BaseService
All Known Implementing Classes:
DDMStructureServiceWrapper

@AccessControlled @CTAware @JSONWebService @ProviderType @Transactional(isolation=PORTAL, rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class}) public interface DDMStructureService extends com.liferay.portal.kernel.service.BaseService
Provides the remote service interface for DDMStructure. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.
See Also:
Generated:
  • Method Summary

    Modifier and Type
    Method
    Description
    addStructure(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)
     
    addStructure(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)
     
    addStructure(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)
     
    copyStructure(long sourceStructureId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    copyStructure(long sourceStructureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    Copies a structure, creating a new structure with all the values extracted from the original one.
    void
    deleteStructure(long structureId)
    Deletes the structure and its resources.
    fetchStructure(long groupId, long classNameId, String structureKey)
    Returns the structure matching the class name ID, structure key, and group.
    fetchStructure(long groupId, long classNameId, String structureKey, boolean includeAncestorStructures)
     
    fetchStructureByExternalReferenceCode(String externalReferenceCode, long groupId, long classNameId)
     
    Returns the OSGi service identifier.
    getStructure(long structureId)
    Returns the structure with the ID.
    getStructure(long groupId, long classNameId, String structureKey)
    Returns the structure matching the class name ID, structure key, and group.
    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.
    getStructureByExternalReferenceCode(String externalReferenceCode, long groupId, long classNameId)
     
    getStructures(long companyId, long[] groupIds, long classNameId, int status)
     
    getStructures(long companyId, long[] groupIds, long classNameId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator)
     
    getStructures(long companyId, long[] groupIds, long classNameId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator)
     
    getStructures(long companyId, long[] groupIds, long classNameId, String keywords, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator)
     
    int
    getStructuresCount(long companyId, long[] groupIds, long classNameId)
     
    int
    getStructuresCount(long companyId, long[] groupIds, long classNameId, String keywords, int status)
     
    void
    revertStructure(long structureId, String version, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    search(long companyId, long[] groupIds, long classNameId, long classPK, String keywords, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator)
     
    search(long companyId, long[] groupIds, long classNameId, String keywords, int type, 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.
    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.
    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.
    int
    searchCount(long companyId, long[] groupIds, long classNameId, long classPK, String keywords, int status)
     
    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.
    int
    searchCount(long companyId, long[] groupIds, long classNameId, String keywords, int type, int status)
    Returns the number of structures matching the groups and class name IDs, and matching the keywords in the structure names and descriptions.
    int
    searchCount(long companyId, long[] groupIds, long classNameId, 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
    updateStructure(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)
     
    updateStructure(long structureId, long parentStructureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, DDMForm ddmForm, DDMFormLayout ddmFormLayout, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
  • Method Details

    • addStructure

      DDMStructure addStructure(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

      DDMStructure addStructure(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

      DDMStructure addStructure(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
    • copyStructure

      DDMStructure copyStructure(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:
      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

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

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

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) DDMStructure fetchStructure(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 group
      classNameId - the primary key of the class name for the structure's related model
      structureKey - the unique string identifying the structure
      Returns:
      the matching structure, or null if a matching structure could not be found
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • fetchStructure

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

      @Transactional(propagation=SUPPORTS, readOnly=true) DDMStructure fetchStructureByExternalReferenceCode(String externalReferenceCode, long groupId, long classNameId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getOSGiServiceIdentifier

      String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getStructure

      @Transactional(propagation=SUPPORTS, readOnly=true) DDMStructure getStructure(long structureId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the structure with the ID.
      Parameters:
      structureId - the primary key of the structure
      Returns:
      the structure with the ID
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getStructure

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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
      Returns:
      the matching structure
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getStructureByExternalReferenceCode

      @Transactional(propagation=SUPPORTS, readOnly=true) DDMStructure getStructureByExternalReferenceCode(String externalReferenceCode, long groupId, long classNameId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getStructures

      @Transactional(propagation=SUPPORTS, readOnly=true) List<DDMStructure> getStructures(long companyId, long[] groupIds, long classNameId, int status)
    • getStructures

      @Transactional(propagation=SUPPORTS, readOnly=true) List<DDMStructure> getStructures(long companyId, long[] groupIds, long classNameId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator)
    • getStructures

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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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)
    • getStructuresCount

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

      @Transactional(propagation=SUPPORTS, readOnly=true) int getStructuresCount(long companyId, long[] groupIds, long classNameId, String keywords, int status)
    • revertStructure

      void revertStructure(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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<DDMStructure> search(long companyId, long[] groupIds, long classNameId, long classPK, String keywords, int status, 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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<DDMStructure> search(long companyId, long[] groupIds, long classNameId, String keywords, int type, 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)
      type - the structure's type. For more information, see DDMStructureConstants.
      status - the workflow's status.
      start - the lower bound of the range of structures to return
      end - the upper bound of the range of structures to return (not inclusive)
      orderByComparator - the comparator to order the structures (optionally null)
      Returns:
      the range of matching structures ordered by the comparator
    • search

      @Transactional(propagation=SUPPORTS, readOnly=true) 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)
      status - the workflow's status.
      start - the lower bound of the range of structures to return
      end - the upper bound of the range of structures to return (not inclusive)
      orderByComparator - the comparator to order the structures (optionally null)
      Returns:
      the range of matching structures ordered by the comparator
    • search

      @Transactional(propagation=SUPPORTS, readOnly=true) 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.
      status - the workflow's status.
      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

      @Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, long[] groupIds, long classNameId, long classPK, String keywords, int status) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • searchCount

      @Transactional(propagation=SUPPORTS, readOnly=true) 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)
      status - the workflow's status.
      Returns:
      the number of matching structures
    • searchCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, long[] groupIds, long classNameId, String keywords, int type, 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)
      type - the structure's type. For more information, see DDMStructureConstants.
      status - the workflow's status.
      Returns:
      the number of matching structures
    • searchCount

      @Transactional(propagation=SUPPORTS, readOnly=true) 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 - 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
      Returns:
      the number of matching structures
    • updateStructure

      DDMStructure updateStructure(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

      DDMStructure updateStructure(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