001/*
002 * (C) Copyright 2006-2007 Nuxeo SA (http://nuxeo.com/) and others.
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 * Contributors:
017 *     Nuxeo - initial API and implementation
018 *
019 * $Id: JOOoConvertPluginImpl.java 18651 2007-05-13 20:28:53Z sfermigier $
020 */
021
022package org.nuxeo.ecm.platform.picture.web;
023
024import java.io.IOException;
025import java.util.ArrayList;
026import java.util.List;
027import java.util.Map;
028
029import javax.faces.model.SelectItem;
030
031
032/**
033 * Provide Creation Book related actions.
034 *
035 * @author <a href="mailto:ldoguin@nuxeo.com">Laurent Doguin</a>
036 * @deprecated since 6.0. See NXP-15370.
037 */
038@Deprecated
039public interface PictureBookManager {
040
041    /**
042     * Sets the title. This is the title of the PictureBook as defined in the Dublincore schema
043     *
044     * @param title a String holding the title
045     */
046    void setTitle(String title);
047
048    /**
049     * Gets the title. This is the title of the PictureBook as defined in the Dublincore schema.
050     *
051     * @return a String holding the title
052     */
053    String getTitle();
054
055    /**
056     * Gets the views. The views are Map that contains different information about each type of picture you might want.
057     * It has the 3 default following views: Original View, Medium View, used for the slideShow Thumbnail View, used For
058     * the PictureBook.
059     *
060     * @return an ArrayList of Map<String, Object> holding the views
061     */
062    ArrayList<Map<String, Object>> getViews();
063
064    /**
065     * Sets the views. The views are Map that contains different information about each type of picture you might want.
066     * It has the 3 default following views: Original View, Medium View, used for the slideShow Thumbnail View, used For
067     * the PictureBook
068     *
069     * @param views an ArrayList of Map<String, Object> holding the views
070     */
071    void setViews(ArrayList<Map<String, Object>> views);
072
073    /**
074     * Sets the viewtitle. viewtitle is the property title of a view. For example the default title For the Original
075     * view is 'Original'.
076     *
077     * @param viewtitle a String holding the title of a view
078     */
079    void setViewtitle(String viewtitle);
080
081    /**
082     * Gets the viewtitle. viewtitle is the property title of a view. For example the default title For the Original
083     * view is 'Original'
084     *
085     * @return a String holding the title of a view.
086     */
087    String getViewtitle();
088
089    /**
090     * Sets the description. description is a property of a view.
091     *
092     * @param description a String holding the description
093     */
094    void setDescription(String description);
095
096    /**
097     * Gets the description. description is a property of a view.
098     *
099     * @return a String holding the description
100     */
101    String getDescription();
102
103    /**
104     * Sets the tag. tag is a property of a view.
105     *
106     * @param tag a String holding the tag
107     */
108    void setTag(String tag);
109
110    /**
111     * Gets the tag. tag is a property of a view.
112     *
113     * @return a String holding the description
114     */
115    String getTag();
116
117    /**
118     * Sets the maxsize. maxsize is a property of a view. Maximum size of the longest side of a picture. It is used to
119     * create the file of a view.
120     *
121     * @param maxsize an Integer holding the maximum size
122     */
123    void setMaxsize(Integer maxsize);
124
125    /**
126     * Gets the maxsize. maxsize is a property of a view. Maximum size of the longest side of a picture. It is used to
127     * create the file of a view.
128     *
129     * @return an Integer holding the maximum size
130     */
131    Integer getMaxsize();
132
133    /**
134     * Adds the current view to the views ArrayList using viewtitle, description, tag and maxsize.
135     */
136    void addView();
137
138    /**
139     * Creates and saves a Picture Book DocumentModel using views, timeinterval, description and title.
140     */
141    String createPictureBook();
142
143    void reset();
144
145    void initialize();
146
147    String downloadSelectedBook() throws IOException;
148
149    String downloadAll() throws IOException;
150
151    List<SelectItem> getSelectItems();
152
153    void setSelectItems(List<SelectItem> selectItems);
154
155    String[] getSelectedViews();
156
157    void setSelectedViews(String[] selectedViews);
158
159}