Package com.adobe.aemds.guide.service

Interface GuideProgressiveStrategy

  • public interface GuideProgressiveStrategy

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.List<java.lang.Object> getAllSections​(java.util.Map<java.lang.String,​java.lang.String> paramMap)
      Returns the list of sections.
      GuideProgressiveCompletionInfo getCompletionSection​(java.lang.String afpath, java.util.Map<java.lang.String,​java.lang.String> data)
      Returns the completion section of strategy
      java.lang.String getDisplayName()
      Returns the string which briefly describes the strategy
      java.lang.String getName()
      Returns the name which is unique for a strategy
      GuideProgressiveSectionInfo getNextSection​(java.lang.String afPath, java.lang.String currentSectionId, java.util.Map<java.lang.String,​java.lang.String> data)
      Returns: first section in case the currentSectionId is null or empty next section if currentSectionId not null and not empty null if penultimate section, that is next would be completion section
      java.lang.String getServiceType()
      Returns the string which describes the type of service If type is static, then it means that the ordering of section is known prior If it is dynamic, then the ordering is not known

    • Method Detail

      • getName

        java.lang.String getName()
        Returns the name which is unique for a strategy
        Returns:
        name of the strategy

      • getDisplayName

        java.lang.String getDisplayName()
        Returns the string which briefly describes the strategy
        Returns:
        display name of the progressive strategy

      • getServiceType

        java.lang.String getServiceType()
        Returns the string which describes the type of service If type is static, then it means that the ordering of section is known prior If it is dynamic, then the ordering is not known
        Returns:
        service type which can be "static" or "dynamic"

      • getAllSections

        java.util.List<java.lang.Object> getAllSections​(java.util.Map<java.lang.String,​java.lang.String> paramMap)
        Returns the list of sections. This list contains GuideProgressiveSectionInfo and GuideProgressiveCompletionSectionInfo object. In case of static service type, it would give the list of all sections but in case of dynamic it would give only one section
        Parameters:
        paramMap - Represent the list of properties available from strategy's dialog
        Returns:
        list representing all sections

      • getNextSection

        GuideProgressiveSectionInfo getNextSection​(java.lang.String afPath,
                                           java.lang.String currentSectionId,
                                           java.util.Map<java.lang.String,​java.lang.String> data)
        Returns: first section in case the currentSectionId is null or empty next section if currentSectionId not null and not empty null if penultimate section, that is next would be completion section
        Parameters:
        afPath -
        currentSectionId -
        data -
        Returns:
        next section
        See Also:
        GuideProgressiveSectionInfo

      • getCompletionSection

        GuideProgressiveCompletionInfo getCompletionSection​(java.lang.String afpath,
                                                    java.util.Map<java.lang.String,​java.lang.String> data)
        Returns the completion section of strategy
        Parameters:
        afpath -
        data -
        Returns:
        completion section for the given adaptive form path
        See Also:
        GuideProgressiveCompletionInfo