001/*
002 * (C) Copyright 2006-2011 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 *     bstefanescu
018 */
019package org.nuxeo.ecm.automation.core.operations.document;
020
021import org.nuxeo.ecm.automation.core.Constants;
022import org.nuxeo.ecm.automation.core.annotations.Context;
023import org.nuxeo.ecm.automation.core.annotations.Operation;
024import org.nuxeo.ecm.automation.core.annotations.OperationMethod;
025import org.nuxeo.ecm.automation.core.annotations.Param;
026import org.nuxeo.ecm.automation.core.collectors.DocumentModelCollector;
027import org.nuxeo.ecm.core.api.CoreSession;
028import org.nuxeo.ecm.core.api.DocumentModel;
029import org.nuxeo.ecm.core.api.DocumentRef;
030
031/**
032 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
033 */
034@Operation(id = CopyDocument.ID, label = "Copy", category = Constants.CAT_DOCUMENT, description = "Copy the input document into the given folder. The name parameter will be used as the copy name otherwise if not specified the original name will be preserved. The target folder can be specified as an absolute or relative path (relative to the input document) as an UID or by using an EL expression. Return the newly created document (the copy).")
035public class CopyDocument {
036
037    public static final String ID = "Document.Copy";
038
039    @Context
040    protected CoreSession session;
041
042    @Param(name = "target")
043    protected DocumentRef target; // the path or the ID
044
045    @Param(name = "name", required = false)
046    protected String name;
047
048    @OperationMethod(collector = DocumentModelCollector.class)
049    public DocumentModel run(DocumentModel doc) {
050        String n = name;
051        if (name == null || name.length() == 0) {
052            n = doc.getName();
053        }
054        return session.copy(doc.getRef(), target, n);
055    }
056
057    @OperationMethod(collector = DocumentModelCollector.class)
058    public DocumentModel run(DocumentRef ref) {
059        String n = name;
060        if (name == null || name.length() == 0) {
061            n = session.getDocument(ref).getName();
062        }
063        return session.copy(ref, target, n);
064    }
065}