/**
 * 
 */
package ecologylab.bigsemantics.seeding;

import ecologylab.collections.Scope;
import ecologylab.oodss.messages.RequestMessage;
import ecologylab.oodss.messages.ResponseMessage;
import ecologylab.serialization.annotations.simpl_composite;
import ecologylab.serialization.annotations.simpl_inherit;
import ecologylab.serialization.annotations.simpl_scalar;

/**
 * Pass a set of seeds to combinFormation's agents.
 * 
 * Version for client only:
 * 	<li>data slot definitions only with no other functionality.</li>
 * 
 * @author andruid
 */
@simpl_inherit
public class SeedCf extends RequestMessage
{
	/**
	 * Indicates which CFSession the seeding message effect,
	 * in case there are more than one.
	 * The default, 0, indicates the first session that was created,
	 * or if none have been, to create one now, and then use it.
	 */
	@simpl_scalar protected	int		sessionNumber;

	/**
	 * The set of seeds being passed to the combinFormation information collecting agent.
	 */
	@simpl_composite protected		SeedSet seedSet;
	
	/**
	 * If there are multiple seeding requests in a single session, how should we handle it?
	 */
	@simpl_scalar protected	int	handleMultipleRequests;
	
	public static final String[] MULTIPLE_REQUESTS_DIALOG_OPTIONS = {  "ignore", "replace seeds", "mix seeds",    };
	
	// NOTE! These values, except for ASK_USER, are 1 more than the corresponding index into the MULTIPLE_REQUESTS_DIALOG_OPTIONS array.
	
	public static final int MULTIPLE_REQUESTS_IGNORE = 0, MULTIPLE_REQUESTS_REPLACE = 1, MULTIPLE_REQUESTS_MIX = 2, MULTIPLE_REQUESTS_ASK_USER = 99;
	

	/**
	 * Default constructor.
	 */
	public SeedCf()
	{
		super();

	}

	/**
	 * Access the SeedSet slot. If it is currently null, create a new SeedSet, and set the slot to its value.
	 * 
	 * @return	An instance of SeedSet, from the SeedSet slot. Never null.
	 */
	public SeedSet seedSet()
	{
		SeedSet result	= seedSet;
		if (result == null)
		{
			result		= new SeedSet();
			seedSet		= result;
		}
		return result;
	}

	/**
	 * Dummy version -- will never get called, because this version lives only on the client,
	 * and the real functionality is on the server.
	 * 
	 * @param objectRegistry
	 * @return	null
	 */
	@Override
	public ResponseMessage performService(Scope objectRegistry)
	{
		return null;
	}

	/**
	 * Remove entries from the SeedSet, if there is one.
	 */
	public void clear()
	{
		if (seedSet != null)
			seedSet.clear();
	}

	public void setHandleMultipleRequests(int handleMultipleRequests)
	{
		this.handleMultipleRequests = handleMultipleRequests;
	}
}