UIDGenerator (Nuxeo 2021.1.19 API Documentation)

All Known Implementing Classes:

AbstractUIDGenerator
```
public interface UIDGenerator
```
Common interface for UID generators. All UID generators must implement this interface.

Author:

Dragos Mihalache

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`createUID(DocumentModel document)`	Returns a new UID for the given doc.
`String`	`getPropertyName()`	Get the property name used to set the identifier value.
`String[]`	`getPropertyNames()`	Gets the property name used to set the identifier value
`String`	`getSequenceKey(DocumentModel document)`
`void`	`setPropertyName(String propertyName)`	Sets the property name used to set the identifier value.
`void`	`setPropertyNames(String[] propertyNames)`	Set the properties used to set the identifier value.
`void`	`setSequencer(UIDSequencer sequencer)`	The sequencer used to generate unique numbers sequencially.
`void`	`setUID(DocumentModel document)`	Creates a new UID for the given doc and sets the field configured in the generator component with this value.

- Method Detail
  - setPropertyName
```
void setPropertyName(String propertyName)
```
    Sets the property name used to set the identifier value.
    The property must be a string like 'schemaPrefix:fieldName' ; the syntax 'schemaName:fieldName' is also accepted. Could be used as a convenient method when there is only one property to set.
    
    See Also:
    
    setPropertyNames(String[])
  - getPropertyName
```
String getPropertyName()
```
    Get the property name used to set the identifier value.
    
    See Also:
    
    getPropertyNames()
  - setPropertyNames
```
void setPropertyNames(String[] propertyNames)
```
    Set the properties used to set the identifier value.
  - getPropertyNames
```
String[] getPropertyNames()
```
    Gets the property name used to set the identifier value
  - setSequencer
```
void setSequencer(UIDSequencer sequencer)
```
    The sequencer used to generate unique numbers sequencially.
  - getSequenceKey
```
String getSequenceKey(DocumentModel document)
```
  - createUID
```
String createUID(DocumentModel document)
```
    Returns a new UID for the given doc.
  - setUID
```
void setUID(DocumentModel document)
     throws PropertyNotFoundException
```
    Creates a new UID for the given doc and sets the field configured in the generator component with this value.
    
    Throws:
    
    PropertyNotFoundException