1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one 3 * or more contributor license agreements. See the NOTICE file 4 * distributed with this work for additional information 5 * regarding copyright ownership. The ASF licenses this file 6 * to you under the Apache License, Version 2.0 (the 7 * "License"); you may not use this file except in compliance 8 * with the License. You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, 13 * software distributed under the License is distributed on an 14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 * KIND, either express or implied. See the License for the 16 * specific language governing permissions and limitations 17 * under the License. 18 */ 19 package org.apache.chemistry.opencmis.inmemory.storedobj.api; 20 21 import java.util.List; 22 23 import org.apache.chemistry.opencmis.commons.data.ContentStream; 24 import org.apache.chemistry.opencmis.commons.data.Properties; 25 import org.apache.chemistry.opencmis.commons.enums.VersioningState; 26 27 /** 28 * A version series is a concrete object (meaning it can be stored) and has 29 * methods for check-out and checkin. It has a path (is contained in a folder) 30 * In contrast to a non-versioned document it has no content, but versions 31 * instead. 32 * 33 * @author Jens 34 * 35 */ 36 public interface VersionedDocument extends MultiFiling, StoredObject { 37 38 DocumentVersion addVersion(ContentStream content, VersioningState verState, String user); 39 40 /** 41 * delete a version from this object, throw exception if document is checked 42 * out or document does not contain this version 43 * 44 * @param version 45 * version to be removed 46 * @return true if version could be removed, and other versions exist, false 47 * if the deleted version was the last version in this document 48 */ 49 boolean deleteVersion(DocumentVersion version); 50 51 boolean isCheckedOut(); 52 53 void cancelCheckOut(String user); 54 55 DocumentVersion checkOut(ContentStream content, String user); 56 57 void checkIn(boolean isMajor, Properties properties, ContentStream content, String checkinComment, String user); 58 59 List<DocumentVersion> getAllVersions(); 60 61 DocumentVersion getLatestVersion(boolean major); 62 63 String getCheckedOutBy(); 64 65 DocumentVersion getPwc(); 66 67 }