001/*
002 *  Copyright 2022 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.cms.data.holder;
017
018import java.util.Optional;
019
020import org.ametys.cms.data.holder.group.IndexableComposite;
021import org.ametys.cms.data.holder.group.IndexableRepeater;
022import org.ametys.plugins.repository.data.holder.ModelAwareDataHolder;
023import org.ametys.runtime.model.exception.BadDataPathCardinalityException;
024import org.ametys.runtime.model.exception.BadItemTypeException;
025import org.ametys.runtime.model.exception.UndefinedItemPathException;
026import org.ametys.runtime.model.exception.UnknownTypeException;
027
028/**
029 * Interface for indexable data containers
030 */
031public interface IndexableDataHolder extends ModelAwareDataHolder
032{
033    @Override
034    public IndexableComposite getComposite(String compositePath) throws IllegalArgumentException, UnknownTypeException, BadItemTypeException, UndefinedItemPathException, BadDataPathCardinalityException;
035
036    @Override
037    public IndexableComposite getLocalComposite(String compositePath) throws IllegalArgumentException, BadItemTypeException, UndefinedItemPathException, BadDataPathCardinalityException;
038
039    @Override
040    public IndexableComposite getExternalComposite(String compositePath) throws IllegalArgumentException, BadItemTypeException, UndefinedItemPathException, BadDataPathCardinalityException;
041
042    @Override
043    public IndexableRepeater getRepeater(String repeaterPath) throws IllegalArgumentException, BadItemTypeException, UndefinedItemPathException, BadDataPathCardinalityException;
044
045    @Override
046    public IndexableRepeater getLocalRepeater(String repeaterPath) throws IllegalArgumentException, BadItemTypeException, UndefinedItemPathException, BadDataPathCardinalityException;
047    
048    @Override
049    public IndexableRepeater getExternalRepeater(String repeaterPath) throws IllegalArgumentException, BadItemTypeException, UndefinedItemPathException, BadDataPathCardinalityException;
050    
051    @Override
052    public Optional<? extends IndexableDataHolder> getParentDataHolder();
053    
054    @Override
055    public IndexableDataHolder getRootDataHolder();
056}