Package de.xima.fc.interfaces.workflow.reference

Interface IEntityReferenceDescriptor

All Known Implementing Classes:
EntityReferenceDescriptor
public interface IEntityReferenceDescriptor
Interface describing an entity reference and its location
Since:
7.0.0
Author:
XIMA MEDIA GmbH

  • Method Details

    • getKey

      Object getKey()
      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

      IEntityReference getRef()
      Returns:
      The reference to an entity in the properties at the given getKey().