org.jnosql.artemis.document.DocumentWorkflow Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of artemis-document Show documentation

Eclipse JNoSQL Mapping, Artemis API, to document NoSQL databases

The newest version!

/*
 *  Copyright (c) 2017 Otávio Santana and others
 *   All rights reserved. This program and the accompanying materials
 *   are made available under the terms of the Eclipse Public License v1.0
 *   and Apache License v2.0 which accompanies this distribution.
 *   The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 *   and the Apache License v2.0 is available at http://www.opensource.org/licenses/apache2.0.php.
 *
 *   You may elect to redistribute this code under either of these licenses.
 *
 *   Contributors:
 *
 *   Otavio Santana
 */
package org.jnosql.artemis.document;


import org.jnosql.diana.api.document.DocumentEntity;

import java.util.function.UnaryOperator;

/**
 * This implementation defines the workflow to insert an Entity on {@link DocumentTemplate}.
 * The default implementation follows:
 *  {@link DocumentEventPersistManager#firePreEntity(Object)}
 *  {@link DocumentEventPersistManager#firePreDocumentEntity(Object)}
 *  {@link DocumentEntityConverter#toDocument(Object)}
 *  {@link DocumentEventPersistManager#firePreDocument(DocumentEntity)}}
 *  Database alteration
 *  {@link DocumentEventPersistManager#firePostDocument(DocumentEntity)}
 *  {@link DocumentEventPersistManager#firePostEntity(Object)}
 *  {@link DocumentEventPersistManager#firePostDocumentEntity(Object)}
 */
public interface DocumentWorkflow {

    /**
     * Executes the workflow to do an interaction on a database document collection.
     *
     * @param entity the entity to be saved
     * @param action the alteration to be executed on database
     * @param     the entity type
     * @return after the workflow the the entity response
     * @see DocumentTemplate#insert(Object, java.time.Duration) DocumentTemplate#insert(Object)
     * DocumentTemplate#update(Object)
     */
     T flow(T entity, UnaryOperator action);
}