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 *     Florent Guillaume
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.collectors.DocumentModelCollector;
026import org.nuxeo.ecm.core.api.CoreSession;
027import org.nuxeo.ecm.core.api.DocumentModel;
028import org.nuxeo.ecm.core.api.DocumentRef;
029
030/**
031 * Check out the input document.
032 */
033@Operation(id = CheckOutDocument.ID, category = Constants.CAT_DOCUMENT, label = "Check Out", description = "Checks out the input document. Returns back the document.")
034public class CheckOutDocument {
035
036    public static final String ID = "Document.CheckOut";
037
038    @Context
039    protected CoreSession session;
040
041    @OperationMethod(collector = DocumentModelCollector.class)
042    public DocumentModel run(DocumentRef doc) {
043        if (!session.isCheckedOut(doc)) {
044            session.checkOut(doc);
045        }
046        return session.getDocument(doc);
047    }
048
049    @OperationMethod(collector = DocumentModelCollector.class)
050    public DocumentModel run(DocumentModel doc) {
051        if (!doc.isCheckedOut()) {
052            session.checkOut(doc.getRef());
053        }
054        return session.getDocument(doc.getRef());
055    }
056
057}