tao-test/app/tao/models/classes/requiredAction/RequiredActionServiceInterface.php

51 lines
1.6 KiB
PHP

<?php
/**
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; under version 2
* of the License (non-upgradable).
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* Copyright (c) 2015 (original work) Open Assessment Technologies SA;
*
*
*/
namespace oat\tao\model\requiredAction;
/**
* Interface RequiredActionServiceInterface
*
* RequiredActionServiceInterface is the interface of service for work with required actions
* @see oat\tao\model\requiredAction\RequiredActionInterface
*
* @package oat\tao\model\requiredAction
* @author Aleh Hutnilau <hutnikau@1pt.com>
*/
interface RequiredActionServiceInterface
{
const CONFIG_ID = 'tao/requiredAction';
const OPTION_REQUIRED_ACTIONS = 'required_actions';
/**
* Get list of all required actions
* @return RequiredAction[] array of required action instances
*/
public function getRequiredActions();
/**
* Get first action which should be executed (one of action's rules return true).
* @return mixed
*/
public function getActionToBePerformed();
}