Package ddf.catalog.data

Interface RequiredAttributesRegistry

public interface RequiredAttributesRegistry
Manages required attribute values, which correspond to specific metacard types.

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<String>
    getRequiredAttributes(String metacardTypeName)
    Checks if the given attribute is required for the given metacard type.
    boolean
    isRequired(String metacardTypeName, String attributeName)
    Checks if the given attribute is required for the given metacard type.

  • Method Details

    • isRequired

      boolean isRequired(String metacardTypeName, String attributeName)
      Checks if the given attribute is required for the given metacard type.
      Parameters:
      metacardTypeName - the name of the metacard type, cannot be null
      attributeName - the name of the attribute belonging to the metacard type, cannot be null
      Returns:
      a boolean denoting if the attribute is required for the given .
      Throws:
      IllegalArgumentException - if either argument is null

    • getRequiredAttributes

      Set<String> getRequiredAttributes(String metacardTypeName)
      Checks if the given attribute is required for the given metacard type.
      Parameters:
      metacardTypeName - the name of the metacard type, cannot be null
      Returns:
      a set of strings which contains all required attributes for the given .
      Throws:
      IllegalArgumentException - if metacardTypeName is null