Package com.appiancorp.suiteapi.epex.model

Interface Model

All Superinterfaces:
ModelReference
public interface Model extends ModelReference
Model A Model represents a given process model that is intended to run in EPEx.

  • Method Details

    • variableReferencesOnModel

      Set<VariableReferenceOnModel> variableReferencesOnModel()
      Returns:
      unmodifiable Set of VariableReferenceOnModel defined by this process model

    • variableReferenceOnModel

      Optional<VariableReferenceOnModel> variableReferenceOnModel(VariableReference variableReference)
      Parameters:
      variableReference -
      Returns:
      variableReference defined by this model, if present

    • variableReferenceOnModel

      Optional<VariableReferenceOnModel> variableReferenceOnModel(String variableNamespace, String variableName)
      Parameters:
      variableNamespace -
      variableName -
      Returns:
      variableReference defined by this model, if present

    • parameterSignature

      List<VariableReference> parameterSignature()
      Returns:
      unmodifiable List of VariableReferences parameters supported by this process model

    • initiateAsynchronous

      ProcessInstance initiateAsynchronous(Parameter... parameter)
      Asynchronously initiate a process instance of this model. This works by requesting that the process be run, rather than by running it immediately, so there may not be data available immediately. To distinguish between the case of 'no data because not yet run' and 'no data because process has completed and deleted its data', check the process status available from the Process. The process's UUID and process's state are available immediately, regardless of the asynchronous nature.
      Parameters:
      parameter -
      Returns:

    • getProcessReference

      ProcessReference getProcessReference(String processUuid)
      Get a reference to an already existing EPEx process instance. The process must exist at the time of this call.
      Parameters:
      processUuid -
      Returns:

    • getProcess

      ProcessInstance getProcess(ProcessReference processReference)
      Get a process instance.
      Parameters:
      processReference -
      Returns:

    • getName

      Optional<String> getName()
      Returns:
      name if available