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 */
016
017package org.ametys.web.repository.page;
018
019import org.ametys.plugins.repository.AmetysObjectIterable;
020import org.ametys.plugins.repository.AmetysRepositoryException;
021import org.ametys.plugins.repository.RemovableAmetysObject;
022import org.ametys.plugins.repository.data.ametysobject.ModifiableModelLessDataAwareAmetysObject;
023import org.ametys.plugins.repository.data.holder.ModifiableModelAwareDataHolder;
024
025/**
026 * A zone that is modifiable
027 */
028public interface ModifiableZone extends Zone, ModifiableModelLessDataAwareAmetysObject, RemovableAmetysObject
029{
030    /**
031     * Add a new zone item
032     * @return The zone item created
033     * @throws AmetysRepositoryException If an error occured
034     */
035    ModifiableZoneItem addZoneItem() throws AmetysRepositoryException;
036    
037    /**
038     * Retrieve the list of used zone items
039     * @return The list of zone items. Cannot be null.
040     * @throws AmetysRepositoryException if an error occured
041     */
042    @Override
043    AmetysObjectIterable<ModifiableZoneItem> getZoneItems() throws AmetysRepositoryException;
044    
045    /**
046     * Get the view parameters
047     * @return the view parameters
048     * @throws AmetysRepositoryException if an error occurs.
049     */
050    @Override
051    public ModifiableModelAwareDataHolder getZoneParametersHolder() throws AmetysRepositoryException;
052}