001/* 002 * Copyright (c) 2006-2011 Nuxeo SA (http://nuxeo.com/) and others. 003 * 004 * All rights reserved. This program and the accompanying materials 005 * are made available under the terms of the Eclipse Public License v1.0 006 * which accompanies this distribution, and is available at 007 * http://www.eclipse.org/legal/epl-v10.html 008 * 009 * Contributors: 010 * Florent Guillaume 011 */ 012package org.nuxeo.ecm.automation.core.operations.document; 013 014import org.nuxeo.ecm.automation.core.Constants; 015import org.nuxeo.ecm.automation.core.annotations.Context; 016import org.nuxeo.ecm.automation.core.annotations.Operation; 017import org.nuxeo.ecm.automation.core.annotations.OperationMethod; 018import org.nuxeo.ecm.automation.core.collectors.DocumentModelCollector; 019import org.nuxeo.ecm.core.api.CoreSession; 020import org.nuxeo.ecm.core.api.DocumentModel; 021import org.nuxeo.ecm.core.api.DocumentRef; 022 023/** 024 * Check out the input document. 025 */ 026@Operation(id = CheckOutDocument.ID, category = Constants.CAT_DOCUMENT, label = "Check Out", description = "Checks out the input document. Returns back the document.") 027public class CheckOutDocument { 028 029 public static final String ID = "Document.CheckOut"; 030 031 @Context 032 protected CoreSession session; 033 034 @OperationMethod(collector = DocumentModelCollector.class) 035 public DocumentModel run(DocumentRef doc) { 036 if (!session.isCheckedOut(doc)) { 037 session.checkOut(doc); 038 } 039 return session.getDocument(doc); 040 } 041 042 @OperationMethod(collector = DocumentModelCollector.class) 043 public DocumentModel run(DocumentModel doc) { 044 if (!doc.isCheckedOut()) { 045 session.checkOut(doc.getRef()); 046 } 047 return session.getDocument(doc.getRef()); 048 } 049 050}