DirectoryEntryResolver (Nuxeo ECM Projects 8.2 API)

java.lang.Object
- org.nuxeo.ecm.directory.DirectoryEntryResolver

All Implemented Interfaces:

Serializable, ObjectResolver
```
public class DirectoryEntryResolver
extends Object
implements ObjectResolver
```
This ObjectResolver allows to manage integrity for fields containing references to directory's entry.
References contains the directory entry id.

To use it, put the following code in your schema XSD (don't forget the directory name):
```
 {@code
 
   
     
   
 
 
```
For hierarchical directories, which entries reference other entries. You can manage a specific reference containing the full entry path. You have to specify the parent field and the separator used to encode the reference.
```
 {@code
 
   
     
   
 
 
```
It's not necessary to define parentField and separator for directory using schema ending by xvocabulary. The feature is automatically enable.
Since:

7.1

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface org.nuxeo.ecm.core.schema.types.resolver.ObjectResolver
  ObjectResolver.Helper

Field Summary

Fields
Modifier and Type Field and Description

static String NAME

static String PARAM_DIRECTORY

static String PARAM_PARENT_FIELD

static String PARAM_SEPARATOR

Fields
Modifier and Type	Field and Description
`static String`	`NAME`
`static String`	`PARAM_DIRECTORY`
`static String`	`PARAM_PARENT_FIELD`
`static String`	`PARAM_SEPARATOR`

Constructor Summary

Constructors
Constructor and Description

DirectoryEntryResolver()

Constructors
Constructor and Description
`DirectoryEntryResolver()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`configure(Map<String,String> parameters)` Configure this resolver.
`<T> T`	`fetch(Class<T> type, Object value)` Provides the entity referenced by a value, return the entity as expected type.
`Object`	`fetch(Object value)` Provides the entity referenced by a value.
`String`	`getConstraintErrorMessage(Object invalidValue, Locale locale)` Provides an error message to display when some invalid value does not match existing entity.
`Directory`	`getDirectory()`
`DirectoryService`	`getDirectoryService()`
`List<Class<?>>`	`getManagedClasses()` Returns the resolved object types.
`String`	`getName()` Provides this resolver name.
`Map<String,Serializable>`	`getParameters()` Provides this resolver parameters.
`Serializable`	`getReference(Object entity)` Generates a reference to an entity.
`void`	`setDirectory(Directory directory)`
`boolean`	`validate(Object value)` Validates some value references an existing entity.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NAME
```
public static final String NAME
```
    See Also:
    
    Constant Field Values
  - PARAM_DIRECTORY
```
public static final String PARAM_DIRECTORY
```
    See Also:
    
    Constant Field Values
  - PARAM_PARENT_FIELD
```
public static final String PARAM_PARENT_FIELD
```
    See Also:
    
    Constant Field Values
  - PARAM_SEPARATOR
```
public static final String PARAM_SEPARATOR
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DirectoryEntryResolver
```
public DirectoryEntryResolver()
```
- Method Detail
  - configure
```
public void configure(Map<String,String> parameters)
               throws IllegalArgumentException,
                      IllegalStateException
```
    Description copied from interface: ObjectResolver
    
    Configure this resolver.
    
    Specified by:
    
    configure in interface ObjectResolver
    
    Parameters:
    
    parameters - A map of parameter whose keys are parameter names and map value are corresponding values.
    
    Throws:
    
    IllegalArgumentException - If some parameter are not compatible with this resolver.
    
    IllegalStateException - If this resolver is already configured.
  - getManagedClasses
```
public List<Class<?>> getManagedClasses()
```
    Description copied from interface: ObjectResolver
    
    Returns the resolved object types.
    
    Specified by:
    
    getManagedClasses in interface ObjectResolver
  - getDirectoryService
```
public DirectoryService getDirectoryService()
```
  - getDirectory
```
public Directory getDirectory()
```
  - setDirectory
```
public void setDirectory(Directory directory)
```
  - getName
```
public String getName()
```
    Description copied from interface: ObjectResolver
    
    Provides this resolver name.
    
    Specified by:
    
    getName in interface ObjectResolver
    
    Returns:
    
    The resolver name.
  - getParameters
```
public Map<String,Serializable> getParameters()
```
    Description copied from interface: ObjectResolver
    
    Provides this resolver parameters.
    
    Specified by:
    
    getParameters in interface ObjectResolver
    
    Returns:
    
    A map containing
  - validate
```
public boolean validate(Object value)
                 throws IllegalStateException
```
    Description copied from interface: ObjectResolver
    
    Validates some value references an existing entity.
    
    Specified by:
    
    validate in interface ObjectResolver
    
    Parameters:
    
    value - The reference.
    
    Returns:
    
    true if value could be resolved as an existing external reference, false otherwise.
    
    Throws:
    
    IllegalStateException - If this resolver has not been configured.
  - fetch
```
public Object fetch(Object value)
             throws IllegalStateException
```
    Description copied from interface: ObjectResolver
    
    Provides the entity referenced by a value.
    
    Specified by:
    
    fetch in interface ObjectResolver
    
    Parameters:
    
    value - The reference.
    
    Returns:
    
    The referenced entity, null if no entity matches the value.
    
    Throws:
    
    IllegalStateException - If this resolver has not been configured.
  - fetch
```
public <T> T fetch(Class<T> type,
                   Object value)
            throws IllegalStateException
```
    Description copied from interface: ObjectResolver
    
    Provides the entity referenced by a value, return the entity as expected type.
    
    Specified by:
    
    fetch in interface ObjectResolver
    
    value - The reference.
    
    Returns:
    
    The referenced entity, null if no entity matches the value or if this entity cannot be converted as type.
    
    Throws:
    
    IllegalStateException - If this resolver has not been configured.
  - getReference
```
public Serializable getReference(Object entity)
                          throws IllegalStateException
```
    Description copied from interface: ObjectResolver
    
    Generates a reference to an entity.
    
    Specified by:
    
    getReference in interface ObjectResolver
    
    Parameters:
    
    entity - The entity.
    
    Returns:
    
    A reference to the entity or null if its not a managed entity type.
    
    Throws:
    
    IllegalStateException - If this resolver has not been configured.
  - getConstraintErrorMessage
```
public String getConstraintErrorMessage(Object invalidValue,
                                        Locale locale)
```
    Description copied from interface: ObjectResolver
    
    Provides an error message to display when some invalid value does not match existing entity.
    
    Specified by:
    
    getConstraintErrorMessage in interface ObjectResolver
    
    Parameters:
    
    invalidValue - The invalid value that don't match any entity.
    
    locale - The language in which the message should be generated.
    
    Returns:
    
    A message in the specified language or

Class DirectoryEntryResolver

Nested Class Summary

Nested classes/interfaces inherited from interface org.nuxeo.ecm.core.schema.types.resolver.ObjectResolver

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NAME

PARAM_DIRECTORY

PARAM_PARENT_FIELD

PARAM_SEPARATOR

Constructor Detail

DirectoryEntryResolver

Method Detail

configure

getManagedClasses

getDirectoryService

getDirectory

setDirectory

getName

getParameters

validate

fetch

fetch

getReference

getConstraintErrorMessage