ilWorkflow.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2016 ILIAS open source, Extended GPL, see docs/LICENSE */
 
require_once './Services/WorkflowEngine/interfaces/ilDetector.php';
require_once './Services/WorkflowEngine/interfaces/ilNode.php';
 
interface ilWorkflow
{
    // Event handling
 
    public function handleEvent($params);
 
    // Node management
 
    public function addNode(ilNode $node);
 
    public function setStartNode(ilNode $node);
 
    public function registerDetector(ilDetector $detector);
 
    // Status
    public function startWorkflow();
 
    public function stopWorkflow();
 
    public function isActive();
 
    public function onStartWorkflow();
 
    public function onStopWorkflow();
 
    public function onWorkflowFinished();
 
    // Persistence scheme.
    public function getWorkflowData();
 
    public function getWorkflowSubject();
 
    public function getWorkflowContext();
 
    public function getWorkflowClass();
 
    public function getWorkflowLocation();
 
    public function setDbId($id);
 
    public function getDbId();
 
    public function hasDbId();
 
    public function isDataPersistenceRequired();
 
    public function resetDataPersistenceRequirement();
 
    // Instance vars (data objects)
 
    public function defineInstanceVar($id, $name);
 
    public function hasInstanceVarByName($name);
 
    public function hasInstanceVarById($id);
 
    public function getInstanceVarByName($name);
 
    public function getInstanceVarById($id);
 
    public function setInstanceVarByName($name, $value);
 
    public function setInstanceVarById($id, $value);
 
    public function getInstanceVars();
 
    public function flushInstanceVars();
}