1:  2:  3:  4:  5:  6:  7:  8:  9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 

<?php
namespace Nethgui\Module;

/*
 * Copyright (C) 2011 Nethesis S.r.l.
 * 
 * This script is part of NethServer.
 * 
 * NethServer 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, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * NethServer 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 NethServer.  If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * Core module operations
 *
 * A module interface implementation is delegated to
 * - initialize the module (and its submodules)
 * - prepare view parameters
 *
 * @see \Nethgui\Controller\RequestHandlerInterface
 * @since 1.0
 * @api
 */
interface ModuleInterface
{
    /**
     * Authorization required to create a module instance
     */
    const ACTION_INSTANTIATE = 'INSTANTIATE';
    
    /**
     * The Module Identifier is a string that univocally identifies a Module.
     *
     * @return string Returns the unique module identifier
     * @api
     */
    public function getIdentifier();

    /**
     * Sets the reference to the parent Module.
     *
     * @see ModuleCompositeInterface addChild() operation.
     * @return ModuleInterface
     * @api
     */
    public function setParent(ModuleInterface $parentModule);

    /**
     * Gets a reference to the parent Module.
     *
     * @return ModuleInterface
     * @api
     */
    public function getParent();

    /**
     * After initialization a module...
     *
     * @return void
     * @api
     */
    public function initialize();

    /**
     * Prevents double initialization.
     *
     * @return bool FALSE, if not yet initialized, TRUE otherwise.
     * @api
     */
    public function isInitialized();

    /**
     * Gain access to the attributes of this module
     * @api
     * @return \Nethgui\Module\ModuleAttributesInterface     
     */
    public function getAttributesProvider();
}