EntityReferenceDescriptor (FORMCYCLE: BOM 7.0.0-SNAPSHOT API)

java.lang.Object
- de.xima.fc.workflow.EntityReferenceDescriptor

All Implemented Interfaces:

IEntityReferenceDescriptor
```
public final class EntityReferenceDescriptor
extends Object
implements IEntityReferenceDescriptor
```
POJO implementation of IEntityReferenceDescriptor.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

- Constructor Summary
  
  Constructors
  Constructor Description
  
  EntityReferenceDescriptor(Object key, IEntityReference ref)
  New POJO instance with the given data.
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  Object getKey()
  
  IEntityReference getRef()
  
  String toString()
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EntityReferenceDescriptor
```
public EntityReferenceDescriptor(Object key,
                                 IEntityReference ref)
```
    New POJO instance with the given data.
    
    Parameters:
    
    key - Value for getKey()
    
    ref - Value for getRef()
- Method Detail
  - getKey
```
public Object getKey()
```
    Specified by:
    
    getKey in interface IEntityReferenceDescriptor
    
    Returns:
    
    Object identifying the location of the entity reference. You may use any object you wish it is guaranteed that the key you return from readEntityReferences is the same key that will be passed to writeEntityReferences. You can then use this key to write back the entity 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.
  - getRef
```
public IEntityReference getRef()
```
    Specified by:
    
    getRef in interface IEntityReferenceDescriptor
    
    Returns:
    
    The reference to an entity in the properties at the given IEntityReferenceDescriptor.getKey().
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object