PathSegmentService (Nuxeo 2021.1.19 API Documentation)

All Known Implementing Classes:

PathSegmentComponent, PathSegmentServiceCompat, PathSegmentServiceDefault
```
public interface PathSegmentService
```
Service with a method generating a path segment (name) given a DocumentModel about to be created. Usually the title is used to derive the path segment.

Field Summary

Fields
Modifier and Type Field Description

static String NUXEO_MAX_SEGMENT_SIZE_PROPERTY

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`generatePathSegment(String s)`	Generate the path segment to use from a string.
`String`	`generatePathSegment(DocumentModel doc)`	Generate the path segment to use for a `DocumentModel` that's about to be created.
`int`	`getMaxSize()`	Return the path segment max size

- Field Detail
  - NUXEO_MAX_SEGMENT_SIZE_PROPERTY
```
static final String NUXEO_MAX_SEGMENT_SIZE_PROPERTY
```
    Since:
    
    7.4
    
    See Also:
    
    Constant Field Values
- Method Detail
  - generatePathSegment
```
String generatePathSegment(DocumentModel doc)
```
    Generate the path segment to use for a DocumentModel that's about to be created.
    
    Parameters:
    
    doc - the document
    
    Returns:
    
    the path segment, which must not contain any / character
  - generatePathSegment
```
String generatePathSegment(String s)
```
    Generate the path segment to use from a string.
    
    Parameters:
    
    s - the string
    
    Returns:
    
    the path segment, which must not contain any / character
    
    Since:
    
    5.9.2
  - getMaxSize
```
int getMaxSize()
```
    Return the path segment max size
    
    Since:
    
    7.4