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.webapp.versioning;
023
024import java.util.Collection;
025import java.util.Map;
026
027import javax.faces.component.UIComponent;
028import javax.faces.context.FacesContext;
029
030import org.nuxeo.ecm.core.api.DocumentModel;
031import org.nuxeo.ecm.core.api.VersionModel;
032
033/**
034 * Web action listener interface for versioning.
035 *
036 * @author Dragos Mihalache
037 */
038public interface DocumentVersioning {
039
040    /**
041     * Returns the available versioning options for the document parameter and state.
042     *
043     * @param document the document for which the versioning options will be returned
044     * @return a collection of option names.
045     */
046    Collection<VersionModel> getItemVersioningHistory(DocumentModel document);
047
048    /**
049     * Returns the available versioning history for the current document and state.
050     *
051     * @return a collection of option names.
052     */
053    Collection<VersionModel> getCurrentItemVersioningHistory();
054
055    /**
056     * Creates a Map with versioning options (as keys) and labels (as map entry values).
057     */
058    Map<String, String> getVersioningOptionsMap(final DocumentModel documentModel);
059
060    String getVersionLabel(DocumentModel document);
061
062    /**
063     * Versioning increment options - select radio component validator method. Check if an option has been selected.
064     * This is mandatory since the component is being displayed.
065     */
066    void validateOptionSelection(FacesContext context, UIComponent component, Object value);
067
068}