/*
 * Hibernate OGM, Domain model persistence for NoSQL datastores
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later
 * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
 */
package org.hibernate.ogm.datastore.mongodb.options.navigation;

import org.hibernate.ogm.datastore.document.options.AssociationStorageType;
import org.hibernate.ogm.datastore.document.options.navigation.DocumentStorePropertyContext;
import org.hibernate.ogm.datastore.mongodb.options.AssociationDocumentStorageType;
import org.hibernate.ogm.datastore.mongodb.options.ReadPreferenceType;
import org.hibernate.ogm.datastore.mongodb.options.WriteConcernType;

import com.mongodb.WriteConcern;

/**
 * Allows to configure MongoDB-specific options for a single property.
 *
 * @author Davide D'Alto <davide@hibernate.org>
 * @author Gunnar Morling
 */
public interface MongoDBPropertyContext extends DocumentStorePropertyContext<MongoDBEntityContext, MongoDBPropertyContext> {

	/**
	 * Defines the type of <a href="http://docs.mongodb.org/manual/core/write-concern/">write concern</a> to be applied
	 * when performing write operations in case the current property represents an association. Otherwise the setting
	 * takes no effect.
	 *
	 * @param concern the write concern type
	 * @return this context, allowing for further fluent API invocations
	 */
	MongoDBPropertyContext writeConcern(WriteConcernType concern);

	/**
	 * Specifies a custom {@link WriteConcern} implementation to be applied when performing write operations in case the
	 * current property represents an association. Otherwise the setting takes no effect.
	 * <p>
	 * Either use this option or {@link #writeConcern(WriteConcernType)} but not both at the same type.
	 *
	 * @param writeConcern the write concern
	 * @return this context, allowing for further fluent API invocations
	 */
	MongoDBPropertyContext writeConcern(WriteConcern writeConcern);

	/**
	 * Defines the type of <a href="http://docs.mongodb.org/manual/core/read-preference/">read preference</a> to be
	 * applied when performing read operations in case the current property represents an association. Otherwise the
	 * setting takes no effect.
	 *
	 * @param readPreference the read preference type
	 * @return this context, allowing for further fluent API invocations
	 */
	MongoDBPropertyContext readPreference(ReadPreferenceType readPreference);

	/**
	 * Specifies how association documents should be persisted. Only applies when the current property represents an
	 * association and the association storage strategy is set to {@link AssociationStorageType#ASSOCIATION_DOCUMENT}.
	 *
	 * @param associationDocumentStorage the association document type to be used; overrides any settings on the entity
	 * or global level
	 * @return this context, allowing for further fluent API invocations
	 */
	MongoDBPropertyContext associationDocumentStorage(AssociationDocumentStorageType associationDocumentStorage);
}