rapture.common.api.FieldsApi 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.exception.RaptureException;
import rapture.common.CallingContext;
import java.util.List;
import java.util.Map;
import rapture.common.RaptureField;
import rapture.common.RaptureFolderInfo;


@SuppressWarnings("all")
public interface FieldsApi {
     /**
     * Returns a list of URIs of all documents and folders below this point, mapping the
     * URI to a RaptureFolderInfo object
     * 
     */
     Map listFieldsByUriPrefix(CallingContext context, String authority, int depth);

     /**
     * Retrieves the field definition.
     * 
     */
     RaptureField getField(CallingContext context, String fieldUri);

     /**
     * Create or replace the field definition
     * 
     */
     void putField(CallingContext context, RaptureField field);

     /**
     * Check whether a field definition with the given uri exists
     * 
     */
     Boolean fieldExists(CallingContext context, String fieldUri);

     /**
     * Delete a field definition
     * 
     */
     void deleteField(CallingContext context, String fieldUri);

     /**
     * Returns a list of values referenced by the fields. Note that there is not a simple
     * 1:1 mapping between the returned list and the list of fields supplied as a parameter.
     * 
     */
     List getDocumentFields(CallingContext context, String docURI, List fields);

     /**
     * Behaves similarly to getFieldsFromDocument, except that the supplied content is first
     * added to the document cache, overwriting any previous values.
     * 
     */
     List putDocumentAndGetDocumentFields(CallingContext context, String docURI, String content, List fields);

}