001/*
002 * (C) Copyright 2014 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 *     <a href="mailto:glefevre@nuxeo.com">Gildas</a>
018 */
019package org.nuxeo.ecm.collections.core.automation;
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.collections.api.CollectionManager;
027import org.nuxeo.ecm.core.api.CoreSession;
028import org.nuxeo.ecm.core.api.DocumentModel;
029
030/**
031 * Class for the operation to create a Collection.
032 *
033 * @since 5.9.4
034 */
035@Operation(id = CreateCollectionOperation.ID, category = Constants.CAT_DOCUMENT, label = "Create a collection", description = "Create a new collection. "
036        + "This is returning the document serialization of the created collection.", aliases = { "Collection.CreateCollection" })
037public class CreateCollectionOperation {
038
039    public static final String ID = "Collection.Create";
040
041    @Context
042    protected CoreSession session;
043
044    @Context
045    protected CollectionManager collectionManager;
046
047    @Param(name = "name")
048    protected String name;
049
050    @Param(name = "description", required = false)
051    protected String description;
052
053    @OperationMethod
054    public DocumentModel run(DocumentModel doc) {
055        return collectionManager.createCollection(session, name, description, doc.getPathAsString());
056    }
057
058    @OperationMethod
059    public DocumentModel run() {
060        return collectionManager.createCollection(session, name, description, null);
061    }
062}