GroupServiceImpl.java

/*******************************************************************************
 * Australian National University Data Commons
 * Copyright (C) 2013  The Australian National University
 * 
 * This file is part of Australian National University Data Commons.
 * 
 * Australian National University Data Commons 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.
 * 
 * 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, see <http://www.gnu.org/licenses/>.
 ******************************************************************************/

package au.edu.anu.datacommons.security.service;

import java.util.List;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Service;

import au.edu.anu.datacommons.data.db.dao.GenericDAOImpl;
import au.edu.anu.datacommons.data.db.model.Groups;

/**
 * GroupServiceImpl
 * 
 * Australian National University Data Commons
 * 
 * Service for retrieving groups
 * 
 * JUnit Coverage:
 * None
 * 
 * <pre>
 * Version	Date		Developer				Description
 * 0.1		28/05/2012	Genevieve Turner (GT)	Initial
 * 0.2		20/06/2012	Genevieve Turner (GT)	Created a select all groups that filters out those for which the user has create permissions
 * 0.3		20/08/2012	Genevieve Turner (GT)	Added a method that determines whether the user has permissions to modify groups
 * 0.4		11/12/2022	Genevieve Turner (GT)	Added validation and mass publication methods
 * </pre>
 * 
 */	
@Service("groupServiceImpl")
public class GroupServiceImpl implements GroupService {
	static final Logger LOGGER = LoggerFactory.getLogger(FedoraObjectServiceImpl.class);

	/**
	 * getAll
	 * 
	 * Gets all the groups
	 * 
	 * <pre>
	 * Version	Date		Developer				Description
	 * 0.1		28/05/2012	Genevieve Turner (GT)	Initial
	 * </pre>
	 * 
	 * @return Returns a list of groups
	 */
	public List<Groups> getAll() {
		GenericDAOImpl<Groups, Long> genericDAO = new GenericDAOImpl<Groups, Long>(Groups.class);
		List<Groups> groups = genericDAO.getAll();
		return groups;
	}
	
	/**
	 * getCreateGroups
	 * 
	 * Gets a list of users who have permission to create objects
	 *
	 * <pre>
	 * Version	Date		Developer				Description
	 * 0.2		20/06/2012	Genevieve Turner(GT)	Initial
	 * </pre>
	 * 
	 * @return A list of groups the user has permissions to create objects in
	 * @see au.edu.anu.datacommons.security.service.GroupService#getCreateGroups()
	 */
	public List<Groups> getCreateGroups() {
		GenericDAOImpl<Groups, Long> genericDAO = new GenericDAOImpl<Groups, Long>(Groups.class);
		List<Groups> groups = genericDAO.getAll();
		return groups;
	}
	
	/**
	 * getReviewGroups
	 * 
	 * Gets a list of users who have permissions to review objects
	 *
	 * <pre>
	 * Version	Date		Developer				Description
	 * 0.2		20/08/2012	Genevieve Turner(GT)	Initial
	 * </pre>
	 * 
	 * @return A list of groups the user has permissions to review
	 * @see au.edu.anu.datacommons.security.service.GroupService#getReviewGroups()
	 */
	public List<Groups> getReviewGroups() {
		GenericDAOImpl<Groups, Long> genericDAO = new GenericDAOImpl<Groups, Long>(Groups.class);
		List<Groups> groups = genericDAO.getAll();
		return groups;
	}

	/**
	 * getAllowModifyGroups
	 * 
	 * A list of users who have permissions to modify other users permissions
	 *
	 * <pre>
	 * Version	Date		Developer				Description
	 * 0,1		20/08/2012	Genevieve Turner(GT)	Initial
	 * </pre>
	 * 
	 * @return A list of groups the user has permissions to modify the groups for
	 * @see au.edu.anu.datacommons.security.service.GroupService#getAllowModifyGroups()
	 */
	public List<Groups> getAllowModifyGroups() {
		GenericDAOImpl<Groups, Long> genericDAO = new GenericDAOImpl<Groups, Long>(Groups.class);
		List<Groups> groups = genericDAO.getAll();
		return groups;
	}
	
	/**
	 * getValidationGroups
	 * 
	 * Get the groups that the user is allowed to validate
	 *
	 * <pre>
	 * Version	Date		Developer				Description
	 * 0,4		11/12/2012	Genevieve Turner(GT)	Initial
	 * </pre>
	 * 
	 * @return
	 * @see au.edu.anu.datacommons.security.service.GroupService#getValidationGroups()
	 */
	public List<Groups> getValidationGroups() {
		GenericDAOImpl<Groups, Long> genericDAO = new GenericDAOImpl<Groups, Long>(Groups.class);
		List<Groups> groups = genericDAO.getAll();
		return groups;
	}
	
	/**
	 * getMultiplePublishGroups
	 * 
	 * Get the groups that the user is allowed to perform mass publication on
	 *
	 * <pre>
	 * Version	Date		Developer				Description
	 * 0,4		11/12/2012	Genevieve Turner(GT)	Initial
	 * </pre>
	 * 
	 * @return
	 * @see au.edu.anu.datacommons.security.service.GroupService#getMultiplePublishGroups()
	 */
	public List<Groups> getMultiplePublishGroups() {
		GenericDAOImpl<Groups, Long> genericDAO = new GenericDAOImpl<Groups, Long>(Groups.class);
		List<Groups> groups = genericDAO.getAll();
		return groups;
	}
}