Package org.nuxeo.ecm.core.uidgen
Interface UIDGeneratorService
- All Known Implementing Classes:
UIDGeneratorComponent
public interface UIDGeneratorService
-
Method Summary
Modifier and TypeMethodDescriptioncreateUID
(DocumentModel doc) Retrieves the defaultUIDSequencer
getSequencer
(String name) RetrievesUIDSequencer
by it's nameReturns the uid generator to use for this document.void
setUID
(DocumentModel doc) Creates a new UID for the given doc and sets the field configured in the generator component with this value.
-
Method Details
-
getSequencer
UIDSequencer getSequencer()Retrieves the defaultUIDSequencer
- Returns:
- the default
UIDSequencer
- Since:
- 7.3
-
getSequencer
RetrievesUIDSequencer
by it's name- Parameters:
name
- the name of theUIDSequencer
- Returns:
- the
UIDSequencer
matching the name - Since:
- 7.3
-
getUIDGeneratorFor
Returns the uid generator to use for this document.Choice is made following the document type and the generator configuration.
-
setUID
Creates a new UID for the given doc and sets the field configured in the generator component with this value.- Throws:
PropertyNotFoundException
-
createUID
- Returns:
- a new UID for the given document
-