DocumentViewCodec (Nuxeo 2021.1.19 API Documentation)

All Known Implementing Classes:

AbstractDocumentViewCodec, DocumentFileCodec, DocumentIdCodec, DocumentPathCodec, DocumentPreviewCodec, RestDocumentViewCodec, WebUIRedirectCodec
```
public interface DocumentViewCodec
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`DocumentView`	`getDocumentViewFromUrl(String url)`	Extracts the document view from given url.
`String`	`getPrefix()`
`String`	`getUrlFromDocumentView(DocumentView docView)`	Builds an url from the given document view.
`boolean`	`handleDocumentView(DocumentView docView)`	Returns true if this codec should apply when iterating over codecs to find a matching one.
`boolean`	`handleUrl(String url)`	Returns true if this codec should apply when iterating over codecs to find a matching one.
`void`	`setPrefix(String prefix)`

- Method Detail
  - getPrefix
```
String getPrefix()
```
  - setPrefix
```
void setPrefix(String prefix)
```
  - handleDocumentView
```
boolean handleDocumentView(DocumentView docView)
```
    Returns true if this codec should apply when iterating over codecs to find a matching one.
    
    See Also:
    
    DocumentViewCodecManager.getUrlFromDocumentView(DocumentView, boolean, String)
  - handleUrl
```
boolean handleUrl(String url)
```
    Returns true if this codec should apply when iterating over codecs to find a matching one.
    
    See Also:
    
    DocumentViewCodecManager.getDocumentViewFromUrl(String, boolean, String)
  - getDocumentViewFromUrl
```
DocumentView getDocumentViewFromUrl(String url)
```
    Extracts the document view from given url.
    The url is partial: it does not hold the context path information (server:port/nuxeo).
    
    Parameters:
    
    url - the partial url to redirect to.
    
    Returns:
    
    a document view instance.
  - getUrlFromDocumentView
```
String getUrlFromDocumentView(DocumentView docView)
```
    Builds an url from the given document view.
    The url should be partial: it should not hold the context path information (server:port/nuxeo).