Package org.nuxeo.ecm.core.schema

Interface PropertyCharacteristicHandler

All Known Subinterfaces:
SchemaManager
All Known Implementing Classes:
SchemaManagerImpl
public interface PropertyCharacteristicHandler
Handler used to provide property's characteristics.
Since:
11.1

  • Method Details

    • isSecured

      boolean isSecured(String schema, String path)
      Checks if the property represented by the given schema and path is secured.
      Parameters:
      schema - the schema name
      path - the property path to test
      Returns:
      whether or not the given property is secured (ie: only administrators can edit it)

    • isDeprecated

      boolean isDeprecated(String schema, String path)
      Checks if the property represented by the given schema and path is deprecated.
      Parameters:
      schema - the schema name (not the prefix)
      path - the property path to test
      Returns:
      whether or not this property is marked as deprecated

    • isRemoved

      boolean isRemoved(String schema, String path)
      Checks if the property represented by the given schema and path is removed.
      Parameters:
      schema - the schema name (not the prefix)
      path - the property path to test
      Returns:
      whether or not this property is marked as removed

    • getDeprecatedProperties

      Set<String> getDeprecatedProperties(String schema)
      The returned paths are not Nuxeo xpath as they don't have the schema prefix.
      Parameters:
      schema - the schema name (not the prefix)
      Returns:
      a Set holding the deprecated property path

    • getRemovedProperties

      Set<String> getRemovedProperties(String schema)
      The returned paths are not Nuxeo xpath as they don't have the schema prefix.
      Parameters:
      schema - the schema name (not the prefix)
      Returns:
      a Set holding the removed property path

    • getRetainableProperties

      Set<String> getRetainableProperties()
      The returned paths are not Nuxeo xpath as they don't have the schema prefix.
      Returns:
      a Set holding the retainable property path
      Since:
      2023

    • getRetainableProperties

      Set<String> getRetainableProperties(String schema)
      The returned paths are not Nuxeo xpath as they don't have the schema prefix.
      Parameters:
      schema - the schema name (not the prefix)
      Returns:
      a Set holding the retainable property path
      Since:
      2023

    • getFallback

      Optional<String> getFallback(String schema, String path)
      Returns the fallback associated to this property if exist. Fallbacks exist when property is deprecated or removed.
      Parameters:
      schema - the schema name (not the prefix)
      path - the property path to test
      Returns:
      fallback associated to this property if exist

    • getIndexedProperties

      List<PropertyIndexOrder> getIndexedProperties(String schema)
      Returns the indexed property paths.

      The returned paths are not Nuxeo xpath as they don't have the schema prefix.

      Parameters:
      schema - the schema name (not the prefix)
      Returns:
      a List holding the indexed property paths.
      Since:
      2021.8