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.runtime.model;
017
018import java.util.Map;
019
020import org.apache.cocoon.ProcessingException;
021
022/**
023 * Interface for view items
024 */
025public interface ViewItem
026{
027    /**
028     * Converts the view item in a JSON map
029     * @return The view item as a JSON map
030     * @throws ProcessingException If an error occurs when converting the view item
031     */
032    public Map<String, Object> toJSON() throws ProcessingException;
033    
034    /**
035     * Retrieves the name of the view item
036     * @return the name of the view item
037     */
038    public String getName();
039}