Class DDMStructureServiceWrapper

java.lang.Object
com.liferay.dynamic.data.mapping.service.DDMStructureServiceWrapper
All Implemented Interfaces:
DDMStructureService, com.liferay.portal.kernel.service.BaseService, com.liferay.portal.kernel.service.ServiceWrapper<DDMStructureService>

public class DDMStructureServiceWrapper extends Object implements DDMStructureService, com.liferay.portal.kernel.service.ServiceWrapper<DDMStructureService>
Provides a wrapper for DDMStructureService.
See Also:
Generated:
  • Constructor Details

    • DDMStructureServiceWrapper

      public DDMStructureServiceWrapper()
    • DDMStructureServiceWrapper

      public DDMStructureServiceWrapper(DDMStructureService ddmStructureService)
  • Method Details

    • addStructure

      public 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
      Specified by:
      addStructure in interface DDMStructureService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addStructure

      public 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
      Specified by:
      addStructure in interface DDMStructureService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addStructure

      public 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
      Specified by:
      addStructure in interface DDMStructureService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • copyStructure

      public 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.
      Specified by:
      copyStructure in interface DDMStructureService
      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

      public DDMStructure copyStructure(long sourceStructureId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      copyStructure in interface DDMStructureService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteStructure

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

      Specified by:
      deleteStructure in interface DDMStructureService
      Parameters:
      structureId - the primary key of the structure to be deleted
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • fetchStructure

      public 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.
      Specified by:
      fetchStructure in interface DDMStructureService
      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

      public DDMStructure fetchStructure(long groupId, long classNameId, String structureKey, boolean includeAncestorStructures) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      fetchStructure in interface DDMStructureService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • fetchStructureByExternalReferenceCode

      public DDMStructure fetchStructureByExternalReferenceCode(String externalReferenceCode, long groupId, long classNameId) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      fetchStructureByExternalReferenceCode in interface DDMStructureService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getOSGiServiceIdentifier

      public String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Specified by:
      getOSGiServiceIdentifier in interface DDMStructureService
      Returns:
      the OSGi service identifier
    • getStructure

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

      public 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.
      Specified by:
      getStructure in interface DDMStructureService
      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 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.

      Specified by:
      getStructure in interface DDMStructureService
      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

      public DDMStructure getStructureByExternalReferenceCode(String externalReferenceCode, long groupId, long classNameId) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      getStructureByExternalReferenceCode in interface DDMStructureService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getStructures

      public List<DDMStructure> getStructures(long companyId, long[] groupIds, long classNameId, int status)
      Specified by:
      getStructures in interface DDMStructureService
    • getStructures

      public List<DDMStructure> getStructures(long companyId, long[] groupIds, long classNameId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator)
      Specified by:
      getStructures in interface DDMStructureService
    • getStructures

      public List<DDMStructure> getStructures(long companyId, long[] groupIds, long classNameId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator)
      Specified by:
      getStructures in interface DDMStructureService
    • getStructures

      public 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)
      Specified by:
      getStructures in interface DDMStructureService
    • getStructuresCount

      public int getStructuresCount(long companyId, long[] groupIds, long classNameId)
      Specified by:
      getStructuresCount in interface DDMStructureService
    • getStructuresCount

      public int getStructuresCount(long companyId, long[] groupIds, long classNameId, String keywords, int status)
      Specified by:
      getStructuresCount in interface DDMStructureService
    • revertStructure

      public void revertStructure(long structureId, String version, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      revertStructure in interface DDMStructureService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • search

      public 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
      Specified by:
      search in interface DDMStructureService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • search

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

      Specified by:
      search in interface DDMStructureService
      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

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

      Specified by:
      search in interface DDMStructureService
      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

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

      Specified by:
      search in interface DDMStructureService
      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

      public int searchCount(long companyId, long[] groupIds, long classNameId, long classPK, String keywords, int status) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      searchCount in interface DDMStructureService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • searchCount

      public 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.
      Specified by:
      searchCount in interface DDMStructureService
      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

      public 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.
      Specified by:
      searchCount in interface DDMStructureService
      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

      public 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
      Specified by:
      searchCount in interface DDMStructureService
      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

      public 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
      Specified by:
      updateStructure in interface DDMStructureService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateStructure

      public 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
      Specified by:
      updateStructure in interface DDMStructureService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getWrappedService

      public DDMStructureService getWrappedService()
      Specified by:
      getWrappedService in interface com.liferay.portal.kernel.service.ServiceWrapper<DDMStructureService>
    • setWrappedService

      public void setWrappedService(DDMStructureService ddmStructureService)
      Specified by:
      setWrappedService in interface com.liferay.portal.kernel.service.ServiceWrapper<DDMStructureService>