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 
<?php

/* --------------------------------------------------------------
  AdminAccessGroupReaderInterface.inc.php 2018-01-22
  Gambio GmbH
  http://www.gambio.de
  Copyright (c) 2017 Gambio GmbH
  Released under the GNU General Public License (Version 2)
  [http://www.gnu.org/licenses/gpl-2.0.html]
  --------------------------------------------------------------
*/

/**
 * Interface AdminAccessGroupReaderInterface
 *
 * @category   System
 * @package    AdminAccess
 * @subpackage Readers
 */
interface AdminAccessGroupReaderInterface
{
    /**
     * Returns an AdminAccessGroup instance by the given AccessGroup ID.
     *
     * @param IdType $groupId Group ID.
     *
     * @return AdminAccessGroupInterface Group object.
     *
     * @throws GroupNotFoundException
     */
    public function getById(IdType $groupId);
    
    
    /**
     * Returns an AdminAccessGroup instance by the given group identifier.
     *
     * @param NonEmptyStringType $pageIdentifier Page Identifier.
     *
     * @return AdminAccessGroupInterface Group object.
     *
     * @throws GroupNotFoundException
     */
    public function getByPage(NonEmptyStringType $pageIdentifier);
    
    
    /**
     * Returns an AdminAccessGroup instance by the given ajax handler identifier.
     *
     * @param NonEmptyStringType $identifier Identifier.
     *
     * @return AdminAccessGroupInterface Group object.
     *
     * @throws GroupNotFoundException
     */
    public function getByAjaxHandler(NonEmptyStringType $identifier);
    
    
    /**
     * Returns an AdminAccessGroup instance by the given group identifier.
     *
     * @param NonEmptyStringType $controllerIdentifier Controller identifier.
     *
     * @return AdminAccessGroupInterface Group object.
     *
     * @throws GroupNotFoundException
     */
    public function getByController(NonEmptyStringType $controllerIdentifier);
    
    
    /**
     * Returns an AdminAccessGroupCollection with all existing AdminAccessGroup objects.
     *
     * @return AdminAccessGroupCollection Group collection with all available groups.
     */
    public function getAll();
    
    
    /**
     * Returns an AdminAccessGroupCollection instance with all child groups for the given group ID.
     *
     * @param IdType $groupId Group ID.
     *
     * @return AdminAccessGroupCollection Group collection.
     */
    public function getChildren(IdType $groupId);
}