CourseDAO.java

/*
 * #%L
 * Course Signup Implementation
 * %%
 * Copyright (C) 2010 - 2013 University of Oxford
 * %%
 * Licensed under the Educational Community License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *             http://opensource.org/licenses/ecl2
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package uk.ac.ox.oucs.vle;

import java.util.*;

import uk.ac.ox.oucs.vle.CourseSignupService.Range;
import uk.ac.ox.oucs.vle.CourseSignupService.Status;

public interface CourseDAO {
	
	CourseGroupDAO findCourseGroupById(String courseId);
	
	CourseGroupDAO findAvailableCourseGroupById(String courseId);
	
	List<CourseGroupDAO> findCourseGroupByDept(String dept, Range range, Date now, boolean external);
	
	List<CourseGroupDAO> findCourseGroupBySubUnit(String subunit, Range range, Date now, boolean external);
	
	List<CourseGroupDAO> findCourseGroupByComponent(String componentId);
	
	List<CourseComponentDAO> findCourseGroupsByCalendar(boolean external, String providerId);
	
	List<CourseComponentDAO> findCourseGroupsByNoDates(boolean external, String providerId);
	
	List<Object[]> findSubUnitByDept(String dept);

	List<CourseComponentDAO> findCourseComponents(String courseId, Range range, Date now);
	
	List<CourseGroupDAO> findAllGroups();
		
	List<CourseComponentDAO> findAllComponents();

	CourseGroupDAO findUpcomingComponents(String courseId, Date available);
	
	CourseComponentDAO findCourseComponent(String id);
	
	CourseComponentDAO newCourseComponent(String id);

	CourseSignupDAO newSignup(String userId, String supervisorId, Date now);

	String save(CourseSignupDAO signupDao);

	void save(CourseComponentDAO componentDao);

	CourseSignupDAO findSignupById(String signupId);
	
	CourseSignupDAO findSignupByEncryptId(String signupId);

	List<CourseSignupDAO> findSignupForUser(String userId, Set<Status> statuses);

	CourseGroupDAO newCourseGroup(String id, String title, String dept, String subunit);

	void save(CourseGroupDAO groupDao);

	List<CourseGroupDAO> findAdminCourseGroups(String userId);
	
	List<CourseGroupDAO> findLecturingCourseGroups(String userId);

	List<CourseSignupDAO> findSignupByCourse(String userId, String courseId, Set<Status> statuses);
	
	Integer countSignupByCourse(String courseId, Set<Status> statuses, Date now);

	List<CourseGroupDAO> findCourseGroupByWords(String[] words, Range range, Date date, boolean external);

	List<CourseSignupDAO> findSignupByComponent(String componentId, Set<Status> statuses);

	/**
	 * This is used for exporting signups. It loads all the groups and signups associated with a component.
	 * The reason for this method is so that when we're exporting details of the signups we don't make multiple
	 * queries to the DB for each exported item.
	 *
	 * @return A list of maps with keys of "this", "signup", and "group". "this" is a component.
     */
	List<Map> findComponentSignups(final String componentId, final Set<Status> statuses, final Integer year) ;
	
	List<CourseSignupDAO> findSignupByComponent(String componentId, Set<Status> statuses, Integer year);

	List<CourseSignupDAO> findSignupPending(String currentUser);
	
	List<CourseSignupDAO> findSignupApproval(String currentUser);
	
	List<CourseSignupDAO> findSignupStillPendingOrAccepted(final Integer period);
	
	List<CourseDepartmentDAO> findApproverDepartments(String currentUserId);
	
	List<Object[]> findDepartmentApprovers(final String department);
	
	List<CourseDepartmentDAO> findAllDepartments();
	
	CourseDepartmentDAO findDepartmentByCode(String code);
	
	CourseDepartmentDAO findDepartmentByPrimaryOrgUnit(String primaryorgUnit);
	
	void save(CourseDepartmentDAO departmentDao);
	
	CourseSubunitDAO findSubunitByCode(String code);
	
	void save(CourseSubunitDAO subunitDao);
	
	CourseOucsDepartmentDAO findOucsDeptByCode(String code);
	
	void save(CourseOucsDepartmentDAO oucsDao);

	void remove(CourseSignupDAO existingSignup);

	
	public int flagSelectedCourseGroups(final String source);
	
	public int flagSelectedCourseComponents(final String source);

	/**
	 * Look for groups for which all the components are in the future and which
	 * don't have any signups and mark them as deleted.
	 * @param source The source to delete groups from. Each importer should have a unique source.
	 * @param now The current date/time.
	 * @return The number of groups flagged as deleted.
	 */
	int flagSelectedDaisyCourseGroups(String source, Date now);

	/**
	 * Look for components that don't have any signups and that have a basedate in the future
	 * and mark them as deleted.
	 * @param source The source to delete groups from. Each importer should have a unique source.
	 * @param now The current date/time.
	 * @return The number of groups flagged as deleted.
	 */
	int flagSelectedDaisyCourseComponents(String source, Date now);
	
	public Collection<CourseGroupDAO> deleteSelectedCourseGroups(final String source);
	
	public Collection<CourseComponentDAO> deleteSelectedCourseComponents(final String source);
	
	public CourseCategoryDAO findCourseCategory(String id);
	
	void save(CourseCategoryDAO category);

	/**
	 * This was created to allow the importers to flush to the DB more quickly as we were seeing
	 * issues where some collections where getting lose and not flushed to the DB.
	 * @param i The flushmode.
	 */
	void setFlushMode(int i);

}