PathSegmentService.java

/*
 * Copyright (c) 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Florent Guillaume
 */
package org.eclipse.ecr.core.api.pathsegment;

import org.eclipse.ecr.core.api.ClientException;
import org.eclipse.ecr.core.api.DocumentModel;

/**
 * Service with a method generating a path segment (name) given a
 * {@link DocumentModel} about to be created. Usually the title is used to
 * derive the path segment.
 */
public interface PathSegmentService {

    /**
     * Generate the path segment to use for a {@link DocumentModel} that's about
     * to be created.
     *
     * @param doc the document
     * @return the path segment, which must not contain any {@code /} character
     */
    String generatePathSegment(DocumentModel doc) throws ClientException;

}