/*******************************************************************************
* This file is part of OpenNMS(R).
*
* Copyright (C) 2009-2011 The OpenNMS Group, Inc.
* OpenNMS(R) is Copyright (C) 1999-2011 The OpenNMS Group, Inc.
*
* OpenNMS(R) is a registered trademark of The OpenNMS Group, Inc.
*
* OpenNMS(R) 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.
*
* OpenNMS(R) 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 OpenNMS(R). If not, see:
* http://www.gnu.org/licenses/
*
* For more information contact:
* OpenNMS(R) Licensing <license@opennms.org>
* http://www.opennms.org/
* http://www.opennms.com/
*
* From the original copyright headers:
*
* Copyright (c) 2009+ desmax74
* Copyright (c) 2009+ The OpenNMS Group, Inc.
*
* This program was developed and is maintained by Rocco RIONERO
* ("the author") and is subject to dual-copyright according to
* the terms set in "The OpenNMS Project Contributor Agreement".
*
* The author can be contacted at the following email address:
*
* Massimiliano Dessì
* desmax74@yahoo.it
*******************************************************************************/
package org.opennms.acl.repository;
import java.util.List;
import org.opennms.acl.model.AuthorityDTO;
import org.opennms.acl.model.Pager;
/**
* Contract to insert/update/read/delete the authorities
*
* @author Massimiliano Dessì (desmax74@yahoo.it)
* @since jdk 1.5.0
* @version $Id: $
*/
public interface AuthorityRepository {
/**
* Save an authorityDTO
*
* @param authority a {@link org.opennms.acl.model.AuthorityDTO} object.
* @return the result of the operation
*/
public Boolean save(AuthorityDTO authority);
/**
* Retrieve an authority by id
*
* @param id a {@link java.lang.Integer} object.
* @return authority
*/
public AuthorityDTO getAuthority(Integer id);
/**
* Remove an authority by id
*
* @param id a {@link java.lang.Integer} object.
* @return the result of the operation
*/
public Boolean removeAuthority(Integer id);
/**
* <p>getAuthorities</p>
*
* @param pager a {@link org.opennms.acl.model.Pager} object.
* @return paginated list of authorities
*/
public List<AuthorityDTO> getAuthorities(Pager pager);
/**
* <p>getAuthorities</p>
*
* @return list of all authorities
*/
public List<AuthorityDTO> getAuthorities();
/**
* <p>getAuthoritiesNumber</p>
*
* @return numbers of authorities present in the system
*/
public Integer getAuthoritiesNumber();
/**
* <p>getUserAuthorities</p>
*
* @param username a {@link java.lang.String} object.
* @return the list of user's authorities by username
*/
public List<AuthorityDTO> getUserAuthorities(String username);
/**
* <p>getFreeAuthorities</p>
*
* @param username a {@link java.lang.String} object.
* @return the list of authorities that user doesn't have
*/
public List<AuthorityDTO> getFreeAuthorities(String username);
/**
* <p>getFreeAuthoritiesForGroup</p>
*
* @return the list of authorities that Group doesn't have
*/
public List<AuthorityDTO> getFreeAuthoritiesForGroup();
/**
* Save a list of authorities for a given group
*
* @param authorities a {@link java.util.List} object.
* @return the result of operation
* @param id a {@link java.lang.Integer} object.
*/
public Boolean saveAuthorities(Integer id, List<Integer> authorities);
/**
* Delete all user's authorities
*
* @param username
* @return the result of the operation
*/
// public Boolean deleteUserAuthorities(String username);
/**
* Delete all user's groups
*
* @param username a {@link java.lang.String} object.
* @return the result of the operation
*/
public Boolean deleteUserGroups(String username);
/**
* <p>getIdItemsAuthority</p>
*
* @param id a {@link java.lang.Integer} object.
* @return a {@link java.util.List} object.
*/
public List<Integer> getIdItemsAuthority(Integer id);
/**
* <p>getGroupAuthorities</p>
*
* @param id a {@link java.lang.Integer} object.
* @return a {@link java.util.List} object.
*/
public List<AuthorityDTO> getGroupAuthorities(Integer id);
/**
* <p>removeGroupFromAuthorities</p>
*
* @param id a {@link java.lang.Integer} object.
* @return a {@link java.lang.Boolean} object.
*/
public Boolean removeGroupFromAuthorities(Integer id);
}