001/*
002 * (C) Copyright 2006-2009 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
018 */
019
020package org.nuxeo.ecm.platform.publisher.api;
021
022import org.nuxeo.ecm.core.api.DocumentRef;
023
024import java.io.Serializable;
025
026/**
027 * Interface of a Document that was published into a PublicationNode.
028 *
029 * @author tiry
030 */
031public interface PublishedDocument extends Serializable {
032
033    enum Type {
034        REMOTE, LOCAL, FILE_SYSTEM;
035    }
036
037    DocumentRef getSourceDocumentRef();
038
039    String getSourceRepositoryName();
040
041    String getSourceServer();
042
043    String getSourceVersionLabel();
044
045    String getPath();
046
047    String getParentPath();
048
049    /**
050     * Returns {@code true} if this document is waiting approval, {@code false} otherwise.
051     */
052    boolean isPending();
053
054    /**
055     * Returns the {@code Type} of this PublishedDocument.
056     */
057    Type getType();
058
059}