Package org.nuxeo.ecm.core.uidgen

Interface UIDGeneratorService

All Known Implementing Classes:

UIDGeneratorComponent

public interface UIDGeneratorService

Method Summary

Modifier and Type	Method	Description
String	createUID(DocumentModel doc)
UIDSequencer	getSequencer()	Retrieves the default UIDSequencer
UIDSequencer	getSequencer(String name)	Retrieves UIDSequencer by it's name
List<UIDSequencer>	getSequencers()	Retrieves all UIDSequencer.
UIDGenerator	getUIDGeneratorFor(DocumentModel doc)	Returns 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

getSequencers

List<UIDSequencer> getSequencers()

Retrieves all UIDSequencer.

Returns:

all UIDSequencer.

Since:

2025.0

getSequencer

UIDSequencer getSequencer()

Retrieves the default UIDSequencer

Returns:

the default UIDSequencer

Since:

7.3

getSequencer

UIDSequencer getSequencer(String name)

Retrieves UIDSequencer by it's name

Parameters:

name - the name of the UIDSequencer

Returns:

the UIDSequencer matching the name

Since:

7.3

getUIDGeneratorFor

UIDGenerator getUIDGeneratorFor(DocumentModel doc)

Returns the uid generator to use for this document.

Choice is made following the document type and the generator configuration.

setUID

void setUID(DocumentModel doc)
     throws PropertyNotFoundException

Creates a new UID for the given doc and sets the field configured in the generator component with this value.

Throws:

PropertyNotFoundException

createUID

String createUID(DocumentModel doc)

Returns:

a new UID for the given document