001/*
002 * (C) Copyright 2006-2007 Nuxeo SAS (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     <a href="mailto:ja@nuxeo.com">Julien Anguenot</a>
016 *
017 * $Id: ValidatorsRule.java 28476 2008-01-04 09:52:52Z sfermigier $
018 */
019
020package org.nuxeo.ecm.platform.publisher.rules;
021
022import org.nuxeo.ecm.core.api.DocumentModel;
023
024import java.io.Serializable;
025
026/**
027 * Validators rule API.
028 * <p>
029 * Object aiming at being responsible of computing the validators of a just published document.
030 *
031 * @author <a href="mailto:ja@nuxeo.com">Julien Anguenot</a>
032 */
033public interface ValidatorsRule extends Serializable {
034
035    /**
036     * Computes the list of publishing validators given the document model of the document just published.
037     *
038     * @param dm a Nuxeo Core document model. (the document that just has been published)
039     * @return a list of principal names.
040     * @throws PublishingValidatorException TODO
041     */
042    String[] computesValidatorsFor(DocumentModel dm);
043
044}