com.marklogic.client.document.DocumentWriteOperation Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2012-2016 MarkLogic Corporation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.marklogic.client.document;

import com.marklogic.client.io.marker.AbstractWriteHandle;
import com.marklogic.client.io.marker.DocumentMetadataWriteHandle;

/** A reflection of the write operations queued by calls to add,
 * {@link DocumentWriteSet#add add}, {@link DocumentWriteSet#addDefault addDefault}, or
 * {@link DocumentWriteSet#disableDefault disableDefault}.
 */
public interface DocumentWriteOperation {
    public enum OperationType {
        /** This write operation (REST API mime part) sets the defaults for the 
         * rest of the request.
         * @see 
         *     REST API Guide -> Constructing a Metadata Part
         */
        METADATA_DEFAULT,
        /** This write operation (REST API mime part) clears the defaults for the
         * rest of the request.  While this removes defaults set previously on the
         * request, this does not completely restore server-side defaults.  For
         * more information see the 
         * 
         * REST API Guide -> Example: Reverting to System Default Metadata
         */
        DISABLE_METADATA_DEFAULT,
        /** This write operation (REST API mime part) creates or overwrites
         * one document and/or document metadata.
         * @see 
         *     REST API Guide -> Constructing a Content Part
         * @see 
         *     REST API Guide -> Constructing a Metadata Part
         * @see 
         *     REST API Guide -> Understanding When Metadata is Preserved or Replaced
         */
        DOCUMENT_WRITE
    };

    /** Returns the {@link DocumentWriteOperation.OperationType} set implicitly by your call to
     * {@link DocumentWriteSet#add add}, {@link DocumentWriteSet#addDefault addDefault}, or
     * {@link DocumentWriteSet#disableDefault disableDefault}.
     * @return the operation type which was set implicitly
     */
    public OperationType getOperationType();

    // The uri for this document, whether set explicitly or received from the
    // server after a write with a DocumentDescriptor.
    /** The uri for this document if set explicitly by your call to
     * {@link DocumentWriteSet#add(String, AbstractWriteHandle) add(String, ...)}
     * @return the uri
     */
    public String getUri();

    /** The handle with the metadata as set by your call to
     * {@link DocumentWriteSet#add(String, DocumentMetadataWriteHandle, AbstractWriteHandle) add} or
     * {@link DocumentWriteSet#add(DocumentDescriptor, DocumentMetadataWriteHandle, AbstractWriteHandle) add}.
     * @return the handle with the metadata
     */
    public DocumentMetadataWriteHandle getMetadata();

    /** The handle with the content as set by your call to
     * {@link DocumentWriteSet#add(String, AbstractWriteHandle) add} or
     * {@link DocumentWriteSet#add(DocumentDescriptor, AbstractWriteHandle) add}.
     * @return the handle with the content
     */
    public AbstractWriteHandle getContent();
}