Package com.adobe.forms.foundation.provider

Interface DependencyProvider

  • public interface DependencyProvider

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Map<FormsAssetType,​java.util.Set<java.lang.String>> getDDEReferences​(java.lang.String dataDictionaryID, java.util.List<java.lang.String> ddeReferenceNames)
      Returns the list of assets referring the Data Dictionary (ddName) and using data dictionary element (ddeName) defined in this DD grouped by asset type.
      java.util.Map<FormsAssetType,​java.util.Set<java.lang.String>> getImmediateParentDependencies​(java.lang.String assetId)
      Returns the immediate parent dependencies (assets using) for the asset represented by the passed assetId (path) grouped by asset type.
      boolean hasDDEReferences​(java.lang.String dataDictionaryId, java.util.List<java.lang.String> ddeReferenceNames)
      Checks whethers the passed DDE in DD are being used in any asset
      boolean hasParentDependencies​(java.lang.String assetId)
      Checks whether the asset represented by asset id (path) passed has parent dependencies

    • Method Detail

      • getImmediateParentDependencies

        java.util.Map<FormsAssetType,​java.util.Set<java.lang.String>> getImmediateParentDependencies​(java.lang.String assetId)
                                                                                            throws FormsFoundationException
        Returns the immediate parent dependencies (assets using) for the asset represented by the passed assetId (path) grouped by asset type.
        Parameters:
        assetId - Id (path in repository) of the asset whose parent dependencies to be calculated
        Returns:
        Map of immediate parent dependencies grouped by asset type. Empty map if no such dependencies exist.
        Throws:
        FormsFoundationException

      • hasParentDependencies

        boolean hasParentDependencies​(java.lang.String assetId)
                       throws FormsFoundationException
        Checks whether the asset represented by asset id (path) passed has parent dependencies
        Parameters:
        assetId - Id (path in repository) of the asset whose parent dependencies needs to be checked
        Returns:
        true if asset has any parent dependencies, else false.
        Throws:
        FormsFoundationException

      • getDDEReferences

        java.util.Map<FormsAssetType,​java.util.Set<java.lang.String>> getDDEReferences​(java.lang.String dataDictionaryID,
                                                                                     java.util.List<java.lang.String> ddeReferenceNames)
                                                                              throws FormsFoundationException
        Returns the list of assets referring the Data Dictionary (ddName) and using data dictionary element (ddeName) defined in this DD grouped by asset type.
        Parameters:
        dataDictionaryID - Id (path in repository) of the Data dictionary in which DDE is defined
        ddeReferenceNames - List of Data Dictionary Elements whose usage has to be found
        Returns:
        Map of assets using this DDE grouped by asset type. Empty map if no such dependencies exist.
        Throws:
        FormsFoundationException

      • hasDDEReferences

        boolean hasDDEReferences​(java.lang.String dataDictionaryId,
                         java.util.List<java.lang.String> ddeReferenceNames)
                  throws FormsFoundationException
        Checks whethers the passed DDE in DD are being used in any asset
        Parameters:
        dataDictionaryId - Id (path in repository) of the Data dictionary in which DDE is defined
        ddeReferenceNames - Name of Data Dictionary Element whose usage has to be found
        Returns:
        true if usage exists, false otherwise
        Throws:
        FormsFoundationException