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 Summary

Modifier and Type	Method	Description
Set<String>	getDeprecatedProperties(String schema)	The returned path are not Nuxeo xpath as they don't have the schema prefix.
Optional<String>	getFallback(String schema, String path)	Returns the fallback associated to this property if exist.
Set<String>	getRemovedProperties(String schema)	The returned path are not Nuxeo xpath as they don't have the schema prefix.
boolean	isDeprecated(String schema, String path)	Checks if the property represented by the given schema and path is deprecated.
boolean	isRemoved(String schema, String path)	Checks if the property represented by the given schema and path is removed.
boolean	isSecured(String schema, String path)	Checks if the property represented by the given schema and path is secured.

Method Detail

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 path 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 path 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

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