001/*
002 *  Copyright 2018 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.program;
017
018import java.util.List;
019
020/**
021 * Represents a part of a {@link Program}, traversable, be it the Program itself, a {@link SubProgram} or a {@link Container}.
022 */
023public interface TraversableProgramPart extends ProgramPart
024{
025    /** Name of the attribute holding the direct children */
026    public static final String CHILD_PROGRAM_PARTS = "childProgramParts";
027    
028    /**
029     * Returns the child {@link ProgramPart}s
030     * @return the child {@link ProgramPart}s in a List
031     */
032    public List<ProgramPart> getProgramPartChildren();
033    
034    /**
035     * Determines if this {@link ProgramPart} contains child program parts
036     * @return true if this {@link ProgramPart} contains at least a child program part
037     */
038    public boolean hasProgramPartChildren();
039    
040    /**
041     * Determines if this {@link ProgramPart} contains the given program part as child
042     * @param contentId id of the {@link ProgramPart} to test
043     * @return true if the content is part of this {@link ProgramPart}
044     */
045    public boolean containsProgramPart(String contentId);
046}