DocumentLocation.java

/*
 * (C) Copyright 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Contributors:
 *     <a href="mailto:at@nuxeo.com">Anahide Tchertchian</a>
 *
 * $Id: DocumentLocation.java 25074 2007-09-18 14:23:08Z atchertchian $
 */

package org.nuxeo.ecm.core.api;

import java.io.Serializable;

/**
 * Document server name with its unique identifier within this server.
 */
public interface DocumentLocation extends Serializable {

    /**
     * Returns the document server name.
     */
    String getServerName();

    /**
     * Returns the document reference.
     */
    DocumentRef getDocRef();

    /**
     * Returns the document path reference
     */
    PathRef getPathRef();

    /**
     * Returns the document id reference
     */
    IdRef getIdRef();

}