001/* 002 * (C) Copyright 2016 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 * "Guillaume Renard" 018 */ 019 020package org.nuxeo.ecm.automation.core.operations.collections; 021 022import org.nuxeo.ecm.automation.core.Constants; 023import org.nuxeo.ecm.automation.core.annotations.Context; 024import org.nuxeo.ecm.automation.core.annotations.Operation; 025import org.nuxeo.ecm.automation.core.annotations.OperationMethod; 026import org.nuxeo.ecm.automation.core.annotations.Param; 027import org.nuxeo.ecm.collections.api.CollectionManager; 028import org.nuxeo.ecm.core.api.CoreSession; 029import org.nuxeo.ecm.core.api.DocumentModel; 030 031@Operation(id = MoveCollectionMemberOperation.ID, category = Constants.CAT_DOCUMENT, label = "Reorder members of a collection", 032 description = "Move member1 of a collection right after member2 of the same collection. If member2 is not sepcified," 033 + " the member1 is moved to first position. Returns true if successfully moved.") 034public class MoveCollectionMemberOperation { 035 036 public static final String ID = "Document.MoveCollectionMember"; 037 038 @Context 039 protected CoreSession session; 040 041 @Context 042 protected CollectionManager collectionManager; 043 044 @Param(name = "member1", required = true) 045 protected DocumentModel member1; 046 047 @Param(name = "member2", required = false) 048 protected DocumentModel member2 = null; 049 050 @OperationMethod 051 public boolean run(DocumentModel collection) { 052 if (collection == null) { 053 throw new IllegalArgumentException("Input cannot be null. Pass a collection as input of run method."); 054 } 055 return collectionManager.moveMembers(session, collection, member1, member2); 056 } 057 058}