001/*
002 *  Copyright 2010 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.odf.courselist;
017
018import java.util.List;
019
020
021/**
022 * Interface representing a container of {@link CourseList}
023 */
024public interface CourseListContainer
025{
026    /**
027     * Returns the child course lists
028     * @return the child course lists
029     */
030    public List<CourseList> getCourseLists();
031    
032    /**
033     * Determines if this {@link CourseListContainer} contains the given course list as child
034     * @param clId id of the {@link CourseList} to test
035     * @return true if the course list is part of this {@link CourseListContainer}
036     */
037    public boolean containsCourseList(String clId);
038    
039    /**
040     * Determines if this {@link CourseListContainer} contains child course list
041     * @return true if this {@link CourseListContainer} contains at least a child course list
042     */
043    public boolean hasCourseLists();
044}