Interface DataHelper

All Known Implementing Classes:
ActivityDataHelper, PropertyDataHelper, ViewpointDataHelper

public interface DataHelper
  • Method Summary

    Modifier and Type
    Method
    Description
    get(ItemPath itemPath, String actContext, String dataPath, TransactionKey transactionKey)
    Data helpers are a mechanism that allows easy referencing of different types of data within an Item, and to use that data for process control or generating new data.
  • Method Details

    • get

      String get(ItemPath itemPath, String actContext, String dataPath, TransactionKey transactionKey) throws InvalidDataException, PersistencyException, ObjectNotFoundException
      Data helpers are a mechanism that allows easy referencing of different types of data within an Item, and to use that data for process control or generating new data. They are referenced using a URI-like syntax, usually in workflow vertex properties.
      Parameters:
      itemPath - the current item to be used
      actContext - the current Activity path in which the DataHelper is used
      dataPath - its content is implementation specific
      transactionKey - the transaction transactionKey object used for ClusterStorage methods
      Returns:
      The resolved value
      Throws:
      InvalidDataException - data inconsistency
      PersistencyException - persistency issue
      ObjectNotFoundException - object was not found