rapture.common.api.ScriptDocApi Maven / Gradle / Ivy

Go to download
/**
 * The MIT License (MIT)
 *
 * Copyright (C) 2011-2016 Incapture Technologies LLC
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/**
 * This is an autogenerated file. You should not edit this file as any changes
 * will be overwritten.
 */

package rapture.common.api;
import rapture.common.CallingContext;
import rapture.common.exception.RaptureException;
import java.util.List;
import java.util.Map;
import rapture.common.model.DocumentRepoConfig;
import rapture.common.model.DocumentMetadata;
import rapture.common.RaptureFolderInfo;
import rapture.common.RaptureIdGenConfig;
import rapture.common.model.DocumentWithMeta;
import rapture.common.XferDocumentAttribute;
import rapture.common.model.DocWriteHandle;


@SuppressWarnings("all")
public interface ScriptDocApi {
     /**
     * 
     * 
     */
     Boolean validateDocRepo(String docRepoUri);

     /**
     * 
     * 
     */
     void createDocRepo(String docRepoUri, String config);

     /**
     * 
     * 
     */
     Boolean docRepoExists(String docRepoUri);

     /**
     * 
     * 
     */
     Boolean docExists(String docUri);

     /**
     * 
     * 
     */
     DocumentRepoConfig getDocRepoConfig(String docRepoUri);

     /**
     * 
     * 
     */
     Map getDocRepoStatus(String docRepoUri);

     /**
     * 
     * 
     */
     List getDocRepoConfigs();

     /**
     * 
     * 
     */
     void deleteDocRepo(String docRepoUri);

     /**
     * 
     * 
     */
     void archiveRepoDocs(String docRepoUri, int versionLimit, long timeLimit, Boolean ensureVersionLimit);

     /**
     * 
     * 
     */
     DocumentWithMeta getDocAndMeta(String docUri);

     /**
     * 
     * 
     */
     DocumentMetadata getDocMeta(String docUri);

     /**
     * 
     * 
     */
     DocumentWithMeta revertDoc(String docUri);

     /**
     * 
     * 
     */
     String getDoc(String docUri);

     /**
     * 
     * 
     */
     String putDoc(String docUri, String content);

     /**
     * 
     * 
     */
     Boolean putDocWithVersion(String docUri, String content, int currentVersion);

     /**
     * 
     * 
     */
     DocWriteHandle putDocWithEventContext(String docUri, String content, Map eventContext);

     /**
     * 
     * 
     */
     Boolean deleteDoc(String docUri);

     /**
     * 
     * 
     */
     String renameDoc(String fromDocUri, String toDocUri);

     /**
     * 
     * 
     */
     Map getDocs(List docUris);

     /**
     * 
     * 
     */
     List getDocAndMetas(List docUris);

     /**
     * 
     * 
     */
     List docsExist(List docUris);

     /**
     * 
     * 
     */
     List