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.web.repository.page;
017
018import org.ametys.plugins.repository.AmetysObjectIterable;
019import org.ametys.plugins.repository.AmetysRepositoryException;
020import org.ametys.plugins.repository.data.ametysobject.ModelLessDataAwareAmetysObject;
021import org.ametys.plugins.repository.data.holder.ModelAwareDataHolder;
022
023/**
024 * An {@link Zone} is a part of a page where contents or services can be rendered.
025 * It is composed of {@link ZoneItem}s
026 */
027public interface Zone extends ModelLessDataAwareAmetysObject
028{
029    /** Constant for the name of the data containing the zone item */
030    public static final String ZONEITEM_DATA_NAME = "zoneItem";
031
032    /**
033     * Retrieve the list of used zone items
034     * @return The list of zone items. Cannot be null.
035     * @throws AmetysRepositoryException if an error occured
036     */
037    AmetysObjectIterable<? extends ZoneItem> getZoneItems() throws AmetysRepositoryException;
038    
039    /**
040     * Get the parent page of the zone
041     * @return The parent page. Cannot be null.
042     */
043    Page getPage();
044    
045    /**
046     * Get the view parameters
047     * @return the view parameters
048     * @throws AmetysRepositoryException if an error occurs.
049     */
050    ModelAwareDataHolder getZoneParametersHolder() throws AmetysRepositoryException;
051}