IObjectReferenceDescriptor (formcycle: bom 8.5.6 API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

ObjectReferenceDescriptor
```
public interface IObjectReferenceDescriptor
extends Serializable
```
Interface describing an entity reference and its location

Since:

8.5.0

Author:

XIMA MEDIA GmbH

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Serializable`	`getPath()`	Returns the object identifying the location or path of the object reference.
`IObjectReference`	`getReference()`	Returns the `reference` to an object in the properties at the given `path`.

- Method Detail
  - getPath
```
Serializable getPath()
```
    Returns the object identifying the location or path of the object reference. You may use any serializable object you wish. It is guaranteed that the path you return from readObjectReferences is the same path that will be passed to writeObjectReferences later. You can then use this path to write back the object to the properties model. For example, you may choose to use simple string names; or JSON paths if your properties model contains lists or maps.
    
    Returns:
    
    The path identifying the location of the object reference.
  - getReference
```
IObjectReference getReference()
```
    Returns the reference to an object in the properties at the given path. Usually this is the ID of the object that can be used to identify it.
    
    Returns:
    
    The reference to the object at the path.