DocumentRef (Nuxeo 2021.64.6 API Documentation)

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbsoluteDocumentRef, IdRef, InstanceRef, PathRef
```
public interface DocumentRef
extends Serializable
```
A reference to a core document.
The following two types of references are supported:
- ID references. Refers to the core document by its UUID. See IdRef.
- PATH references. Refers to the core document by its path. See PathRef.
Author:

Bogdan Stefanescu

- Field Summary
  
  Fields
  Modifier and Type Field Description
  
  static int ID
  
  static int INSTANCE
  
  static int PATH
- Method Summary
  
  All Methods Instance Methods Abstract Methods
  Modifier and Type Method Description
  
  Object reference()
  Gets the reference value.
  
  int type()
  Gets the type of the reference.

- Field Detail
  - ID
```
static final int ID
```
    See Also:
    
    Constant Field Values
  - PATH
```
static final int PATH
```
    See Also:
    
    Constant Field Values
  - INSTANCE
```
static final int INSTANCE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - type
```
int type()
```
    Gets the type of the reference.
    
    Returns:
    
    the type of the reference
  - reference
```
Object reference()
```
    Gets the reference value.
    For an ID reference, this is the document UUID.
    For a PATH reference, this is the document path.
    For an INSTANCE reference this is the document itself.
    
    Returns:
    
    the reference value